DataWindow control

You place DataWindow controls in a window or user object and then specify the DataWindow object you want to use within them to display and manipulate data in the window.

A DataWindow object allows users to display, manipulate, and update database or other information. You build DataWindow objects in the DataWindow painter.

For information about DataWindow objects, see Working with DataWindows in Users Guide.

Obsolete functions

Several DataWindow control functions are described as obsolete, which means that although the function operates as usual in this release, it will be removed in a future release. You should replace all use of these functions as soon as possible.

Properties

DataWindow property

Datatype

Description

AccessibleDescription

String

A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.

AccessibleName

String

A label that briefly describes the control, such as the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the control is.

Border

Boolean

Specifies whether the control has a border. Values are:

TRUE -- Control has a border.

FALSE -- Control does not have a border.

BorderStyle

BorderStyle (enumerated)

Specifies the border style of the control. Values are:

StyleBox!

StyleLowered!

StyleRaised!

StyleShadowBox!

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to the top of the front-to-back order.

ClassDefinition

PowerObject

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

ControlMenu

Boolean

Specifies whether the Control Menu box displays in the control title bar. Values are:

TRUE -- Control Menu box displays in the control title bar.

FALSE -- Control Menu box does not display in the control title bar.

DataObject

String

Specifies the name of the DataWindow object associated with the control.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control automatically into Drag Mode. DragAuto has these boolean values:

TRUE -- When the control is clicked, the control is automatically in Drag Mode.

FALSE -- When the control is clicked, the control is not automatically in Drag Mode. You have to put the control into Drag Mode manually by using the Drag function.

DragIcon

String

Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control.

When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.

Enabled

Boolean

Specifies whether the control is enabled (can be selected). Values are:

TRUE -- Control is enabled.

FALSE -- Control is not enabled.

Height

Integer

Specifies the height of the DataWindow control, in PowerBuilder units.

HScrollBar

Boolean

Specifies whether a horizontal scroll bar displays in the control when all the data cannot be displayed at one time. Values are:

TRUE -- Horizontal scroll bar is displayed.

FALSE -- Horizontal scroll bar is not displayed.

HSplitScroll

Boolean

Specifies whether the split bar displays in the control. Values are:

TRUE -- Split bar is displayed.

FALSE -- Split bar is not displayed.

Icon

String

Specifies the name of the ICO file that contains the icon that displays when the DataWindow control is minimized.

LiveScroll

Boolean

Scrolls the rows in the DataWindow control while the user is moving the scroll box.

MaxBox

Boolean

Specifies whether a Maximize Box displays in the DataWindow control title bar. Values are:

TRUE -- Maximize Box displays.

FALSE -- Maximize Box does not display.

MinBox

Boolean

Specifies whether a Minimize Box displays in the DataWindow control title bar. Values are:

TRUE -- Minimize Box displays.

FALSE -- Minimize Box does not display.

Object

DWObject

Used for the direct manipulation of objects within a DataWindow object from a script. These objects can be, for example, columns or text objects.

Resizable

Boolean

Specifies whether the DataWindow control is resizable. Values are:

TRUE -- DataWindow is resizable.

FALSE -- DataWindow is not resizable.

RightToLeft

Boolean

Specifies that characters should be displayed in right-to-left order. The application must be running on an operating system that supports right-to-left display. Values are:

TRUE -- Characters display in right-to-left order.

FALSE -- Characters display in left-to-right order.

TabOrder

Integer

Specifies the tab value of the DataWindow control within the window or user object (0 means the user cannot tab to the control).

Tag

String

Specifies the tag value assigned to the DataWindow control.

Title

String

Specifies the text that displays in the DataWindow control title bar.

TitleBar

Boolean

Specifies whether a title bar displays in the DataWindow control. The user can move the DataWindow control only if it has a title bar. Values are:

TRUE -- Title bar is displayed in control.

FALSE -- No title bar is displayed in control.

Visible

Boolean

Specifies whether the DataWindow control is visible. Values are:

TRUE -- Control is visible.

FALSE -- Control is not visible.

VScrollBar

Boolean

Specifies whether a vertical scroll bar displays in the control when not all the data can be displayed at one time. Values are:

TRUE -- Vertical scroll bar is displayed.

FALSE -- Vertical scroll bar is not displayed.

Width

Integer

Specifies the width of the DataWindow control, in PowerBuilder units.

X

Integer

Specifies the X position (the distance from the left edge of the window), in PowerBuilder units.

Y

Integer

Specifies the Y position (the distance from the top edge of the window), in PowerBuilder units.


Events

Some but not all DataWindow events have return codes that you can use to determine what action is taken after the event occurs. You set the return codes in a RETURN statement in the event script.

DataWindow event

Occurs

ButtonClicked

When the user clicks a button.

ButtonClicking

When the user clicks a button. This event occurs before the ButtonClicked event.

Clicked

When the user clicks between fields in the DataWindow control.

Return codes:

0 - (Default) Continue processing.

1 - Stop processing.

Collapsed

When a node in a TreeView DataWindow has collapsed.

Collapsing

Before a node in a TreeView DataWindow collapses.

Constructor

Immediately before the Open event occurs in the window.

DBError

When a database error occurs in the DataWindow control.

Destructor

Immediately after the Close event occurs in the window.

DoubleClicked

When the user double-clicks between fields in the DataWindow control.

For a RichText presentation style DataWindow, when the user double-clicks in the text.

DragDrop

When a dragged control is dropped on the DataWindow control.

DragEnter

When a dragged control enters the DataWindow control.

DragLeave

When a dragged control leaves the DataWindow control.

DragWithin

When a dragged control is within the DataWindow control.

EditChanged

When a user types in an edit control in the DataWindow control.

Error

When an error is found in a data or property expression for a DataWindow object.

Expanded

When a node in a TreeView DataWindow has expanded.

Expanding

Before a node in a TreeView DataWindow expands.

GetFocus

Just before the DataWindow control receives focus (before it is selected and becomes active).

Help

When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control.

ItemChanged

When a field in the DataWindow has been modified and loses focus (for example, the user presses Enter, the Tab key, or an arrow key, or clicks the mouse on another field within the DataWindow).

Return codes:

0 - (Default) Accept the data value.

1 - Reject the data value and do not allow focus to change.

2 - Reject the data value but allow focus to change.

ItemError

When a field has been modified, the field loses focus (for example, the user presses Enter, Tab, or an arrow key, or clicks the mouse on another field), and the field does not pass the validation rules for its column.

Return codes:

0 - (Default) Reject the data value and show an error message box.

1 - Reject the data value with no message box.

2 - Accept the data value.

3 - Reject the data value but allow focus to change.

If the Return code is 0 or 1 (rejects the data), the field with the incorrect data regains the focus.

ItemFocusChanged

When the current item in the control changes.

LoseFocus

When the DataWindow control loses focus (becomes inactive).

Other

When a Windows message occurs that is not a PowerBuilder event.

Printend

When the printing of the DataWindow ends.

PrintPage

Before each page of the DataWindow is formatted for printing.

Return codes:

0 - Do not skip a page.

1 - Skip a page.

PrintStart

When the printing of the DataWindow starts.

RButtonDown

When the right mouse button is pressed on the control.

For a RichText presentation style DataWindow, if PopUp Menu has been turned on, this event is not triggered when the right mouse button is pressed.

Resize

When the user or a script resizes a DataWindow control.

RetrieveEnd

When the retrieval for the DataWindow is complete.

RetrieveRow

After a row has been retrieved.

Return codes:

0 - (Default) Continue.

1 - Stop the retrieval.

RetrieveStart

When the retrieval for the DataWindow is about to begin.

Return codes:

0 - (Default) Continue.

1 - Do not perform the retrieval.

2 - Do not reset the rows and buffers before retrieving the data from the database.

RowFocusChanged

When the current row changes in the DataWindow.

RowFocusChanging

When the current row is about the change in the DataWindow. This event occurs before the RowFocusChanged event.

ScrollHorizontal

When the user scrolls right or left in the DataWindow control with the Tab or arrow keys or the scroll bar.

ScrollVertical

When the user scrolls up or down in the DataWindow control with the Tab or arrow keys or the scroll bar.

SQLPreview

After a Retrieve, Update, or ReselectRow function call and immediately before the SQL statement is submitted to the DBMS.

The following return codes specify the action that takes place when the event occurs after an Update function call only:

0 - (Default) Continue.

1 - Stop.

2 - Skip this request and execute the next request.

UpdateEnd

When all the updates from the DataWindow to the database are complete.

UpdateStart

After an Update function call and just before changes in the DataWindow are sent to the database.

Return codes:

0 - (Default) Continue.

1 - Do not perform the update.

WSError

Occurs when an error is returned for a DataWindow using the WSConnection object to connect to a Web service data source.


Functions

DataWindow function

Datatype returned

Description

AcceptText

Integer

Applies the contents of the DataWindow control's edit control to the current item in the DataWindow buffer.

CanUndo

Boolean

Specifies whether the last edit can be undone with the Undo function. Applies to the edit control over the current row and column. Values are:

TRUE -- Last edit can be undone.

FALSE -- Last edit cannot be undone.

CategoryCount

Integer

Returns the number of categories in the specified graph in the DataWindow control.

CategoryName

String

Returns the name of the specified category in the specified graph in the DataWindow control.

ClassName

String

Returns the name assigned to the DataWindow control.

Clear

Integer

Clears (deletes) the selected text in the edit control of the DataWindow control.

For a RichText presentation style DataWindow, clears the selected text in the DataWindow.

ClearValues

Integer

Deletes all items from the value list associated with the specified column in the DataWindow control.

Clipboard

Integer

Copies the specified graph in the DataWindow control to the clipboard.

Copy

Integer

Copies the selected text in the edit control over the current row and column of the DataWindow control to the clipboard.

For a RichText presentation style DataWindow, copies the selected text in the DataWindow control.

CopyRTF

String

Returns the selected text, pictures, and input fields in a DataWindow control as a string with rich text formatting. Bitmaps and input fields are included in the string.

Create

Integer

Creates a DataWindow object using the specified source code and replaces the DataWindow object in the specified DataWindow control with the new DataWindow object.

CrosstabDialog

Integer

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

Cut

Integer

Cuts the selected text from the edit control over the current row and column of the DataWindow and stores it in the clipboard.

For a RichText presentation style DataWindow, cuts the selected text in the DataWindow control.

DataCount

Long

Returns the number of data points in the specified series in the specified graph in the DataWindow control.

DBCancel

Integer

Cancels a database retrieval in progress.

DBErrorCode

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

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

Long

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

DeleteRow

Integer

Deletes the specified row from the DataWindow control.

Describe

String

Returns requested information about the structure of the DataWindow control.

Drag

Integer

Starts or ends the dragging of the DataWindow control.

ExportJson

String

Exports data from the DataWindow control, DataStore object, or DataWindowChild object to the JSON string.

Filter

Integer

Displays specific rows of the DataWindow control based on its current filter.

FilteredCount

Integer

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

Find

Long

Syntax 1: Finds the next row in a DataWindow control in which data meets a specified condition.

Syntax 2: For Rich Text presentation style Data Windows, finds the specified text in the control and highlights the text if found. You can specify search direction and whether to match whole words and case.

FindCategory

Integer

Returns the number of the specified category in the specified graph in the DataWindow control.

FindGroupChange

Long

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

FindNext

Integer

Finds the next occurrence of text in the control and highlights it, using criteria set up in a previous call of the Find function.

This function applies only to DataWindow controls whose content has the RichText presentation style.

FindRequired

Integer

Identifies the required columns that the user has not filled.

FindSeries

Integer

Returns the number of the specified series in the specified graph in the DataWindow control.

GenerateHTMLForm

Integer

Creates an HTML Form element containing columns for one or more rows. Also returns an HTML Style element containing style sheet information.

GenerateResultSet

Long

Returns an EAServer result set from a PowerBuilder user object running as a component on EAServer.

Obsolete function

GenerateResultSet is an obsolete function, because EAServer is no longer supported since PowerBuilder 2017.

GetBandAtPointer

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

Border (enumerated)

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

Box!

Lowered!

NoBorder!

Raised!

ResizeBorder!

ShadowBox!

Underline!

GetChanges

Long

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

GetChild

Integer

Stores in the specified variable the name of the child DataWindow in the specified column.

GetClickedColumn

Integer

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

GetClickedRow

Long

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

GetColumn

Integer

Returns the number of the current column in the DataWindow control.

GetColumnName

String

Returns the name of the current column in the DataWindow control.

GetContextService

Integer

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

GetData

Double

Returns the value of the specified data in the specified series in the specified graph in the DataWindow control. See also GetDataValue in DataWindow Reference.

GetDataPieExplode

Integer

Reports the percentage that a pie slice is exploded in a pie graph.

GetDataLabelling

Integer

Determines whether the data at a given data point is labeled in a DirectX 3D graph.

GetDataStyle

Integer

Finds out the appearance of a data point in a graph. Each data point in a series can have individual appearance settings. There are different syntaxes, depending on what settings you want to check.

GetDataTransparency

Integer

Obtains the transparency percentage of a series in a DirectX 3D graph.

GetDataValue

Integer

Returns the value of the specified data in the specified series in the specified graph in the DataWindow control.

GetFormat

String

Returns the format used for display in the specified column of the DataWindow control.

GetFullState

Long

Retrieves the complete state of a DataWindow into a blob. This function is used primarily in distributed applications.

GetItemDate

Date

Returns the date data in the specified row and column of the DataWindow control.

GetItemDateTime

DateTime

Returns the datetime data in the specified row and column of the DataWindow control.

GetItemDecimal

Decimal

Returns the decimal data in the specified row and column of the DataWindow control.

GetItemNumber

Double

Returns the numeric data in the specified row and column of the DataWindow control.

GetItemStatus

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

String

Returns the string data in the specified row and column of the DataWindow control.

GetItemTime

Time

Returns the time data in the specified row and column of the DataWindow control.

GetMessageText

String

Obtains the message text generated by a crosstab DataWindow object in the DataWindow control.

Obsolete function

GetMessageText is an obsolete function and will be discontinued in a future release. Message text is now available as an argument in a user-defined DataWindow event associated with the token pbm_dwnmessagetext.

GetNextModified

Long

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

GetObjectAtPointer

String

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

GetParent

PowerObject

Returns a reference to the name of the parent object.

GetRow

Long

Returns an integer containing the number of the current row in the DataWindow control.

GetRowFromRowId

Long

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

GetRowIdFromRow

Long

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

GetSelectedRow

Integer

Returns the number of the first selected row after the specified row number in the DataWindow control.

GetSeriesLabelling

Integer

Obtains the series labelling for a DirectX 3D graph.

GetSeriesStyle

Integer

Finds out the appearance of a series in a graph. There are several syntaxes, depending on what settings you want.

GetSeriesTransparency

Integer

Obtains the transparency percentage of a series in a DirectX 3D graph.

GetSQLPreview

String

Returns the current SQL statement the DataWindow control 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

String

Returns the current SELECT statement for the DataWindow control.

GetStateStatus

Long

Retrieves the current status of the internal state flags for a DataWindow and places this information in a blob. This function is used primarily in distributed applications.

GetText

String

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

GetTrans

Integer

Returns the values in the DataWindow Transaction object.

GetUpdateStatus

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 control DBError and SQLPreview events.

GetValidate

String

Returns the validation rule used in the specified column of the DataWindow control.

GetValue

String

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

GroupCalc

Integer

Recalculates the breaks in the groups in the DataWindow control.

Hide

Integer

Makes the control invisible.

ImportClipboard

Long

Copies data from the clipboard to the DataWindow control.

ImportFile

Long

Copies data from a file to the DataWindow control.

ImportJson

Long

Inserts data from a JSON string into the DataWindow control.

ImportJsonByKey

Long

Inserts data from a JSON string into the DataWindow control according to the JSON key name.

ImportString

Long

Copies data from a string to the DataWindow control.

InsertDocument

Integer

Inserts a rich text format or plain text file into a DataWindow control. You use a function parameter to specify how the new content is added:

  • It can be inserted at the insertion point.

  • It can replace all existing content.

This function applies only to DataWindow controls whose content has the RichText presentation style.

InsertRow

Long

Inserts a new initialized row before the specified row in the DataWindow control.

IsSelected

Boolean

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

LineCount

Integer

Determines the number of lines in an edit control that allows multiple lines.

ModifiedCount

Long

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

Modify

String

Uses the specification contained in a string to modify the DataWindow control.

Move

Integer

Moves the specified DataWindow control to a specified location.

ObjectAtPointer

grObjectType

Returns the number of the series the pointer is over and the number of the data point in the graph in the DataWindow control and identifies the object type.

OLEActivate

Integer

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

Paste

Integer

Inserts the contents of the clipboard into the edit control over the current row and column in the DataWindow control.

PasteRTF

Long

Pastes rich text data from a string into a DataWindow control whose content has the RichText presentation style.

PointerX

Integer

Returns the distance of the pointer from the left edge of the DataWindow control.

PointerY

Integer

Returns the distance of the pointer from the top of the DataWindow control.

Position

Integer

Syntax 1: Reports the insertion point's position in the edit control over the current row and column of the DataWindow control.

Syntax 2: Reports the line and column position of the insertion point or the start and end of selected text in a DataWindow control whose content has the RichText presentation style.

PostEvent

Boolean

Adds an event to the end of the message queue for the DataWindow control.

Print

Integer

Sends the content of the DataWindow control to the current printer. This function has several syntaxes.

PrintCancel

Integer

Cancels the print job and deletes the spool file (if any) when the content of the DataWindow control is sent to print.

This function has two syntaxes. Use Syntax 1 when Syntax 1 of the Print function is used to send the content of the DataWindow control to the current printer.

ReplaceText

Integer

Replaces the selected text in the edit control with the specified string.

ReselectRow

Integer

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

Reset

Integer

Clears all the data from a DataWindow control.

Reset

Integer

Deletes the data, the categories, or the series from a graph within a DataWindow object with an external data source.

ResetDataColors

Integer

Resets the color of a data point to the color specified for the series.

ResetTransObject

Integer

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

ResetUpdate

Integer

Resets the update flags for the DataWindow control.

Resize

Integer

Changes the width and height of the DataWindow control.

Retrieve

Long

Retrieves rows from the database for the DataWindow control.

RowCount

Long

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

RowsCopy

Integer

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

RowsDiscard

Integer

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

RowsMove

Integer

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

SaveAs

Integer

Saves the data represented in the specified graph in the DataWindow control to the specified file, in the specified format.

SaveAs

Integer

Saves the content of the DataWindow control to the specified file, in the specified format, with or without column headings at the beginning.

SaveAsAscii

Long

Saves the content of a DataWindow into a standard ASCII text file.

SaveNativePDFToBlob

Integer

Saves the PDF file into a blob variable when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Scroll

Integer

Scrolls the edit control of a DataWindow control in the specified direction the specified number of lines.

ScrollNextPage

Long

Syntax 1: Scrolls forward by the number of rows showing in the DataWindow (when the DataWindow control contents does not have the RichText presentation style).

Syntax 2: Scrolls to the next page of the document in a DataWindow control whose content has the RichText presentation style.

ScrollNextRow

Long

Scrolls the DataWindow control to the next row. ScrollNextRow changes the current row but not the current column.

ScrollPriorPage

Long

Syntax 1: Scrolls backward by the number of rows showing in the DataWindow (when the DataWindow control content does not have the RichText presentation style).

Syntax 2: Scrolls to the prior page of the document in a DataWindow control whose content has the RichText presentation style.

ScrollPriorRow

Long

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

ScrollToRow

Integer

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

SelectedLength

Integer

Reports the total number of characters and spaces (length) in the selected text in the edit control over the current row and column.

SelectedLine

Integer

Reports the line number in the edit control over the current row and column.

SelectedStart

Integer

Reports the starting position in the edit control over the current row and column.

SelectedText

String

Reports what text (if any) is selected in the edit control over the current row and column of the DataWindow control.

SelectRow

Integer

Selects or deselects the specified row in the DataWindow control.

SelectText

Integer

Syntax 1: Selects text in the edit control of a DataWindow control (other than one whose content is in the RichText presentation style). You specify where the selection begins and how many characters to select.

Syntax 2: Selects text beginning and ending at the specified line and character positions in a DataWindow control whose content is in the RichText presentation style.

SelectTextAll

Integer

Selects all the content of a DataWindow control with the RichText presentation style.

SelectTextLine

Integer

Selects the line containing the insertion point in a DataWindow control with the RichText presentation style.

SelectTextWord

Integer

Selects the word containing the insertion point in a DataWindow control with the RichText presentation style.

SeriesCount

Integer

Returns the number of series in the specified graph in the DataWindow control.

SeriesName

String

Returns the name of the specified series in the specified graph in the DataWindow control.

SetActionCode

Integer

Defines the action a DataWindow control takes following an event.

Obsolete function

SetActionCode is an obsolete function and will be discontinued in a future release. You now set return codes in a return statement in the event script.

SetBorderStyle

Integer

Sets the border style of the specified column in the DataWindow control.

SetChanges

Long

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

SetColumn

Integer

Makes the specified column the current column in the DataWindow control.

SetDataPieExplode

Integer

Explodes a pie slice in a pie graph.

SetDataLabelling

Integer

Sets the series label for a DirectX 3D graph.

SetDataStyle

Integer

For the specified data point in the specified series in the specified graph in the DataWindow control:

Syntax 1: Sets the data point's color.

Syntax 2: Sets the line style and width for the data point.

Syntax 3: Sets the fill pattern or symbol for the data point.

SetDataTransparency

Integer

Sets the transparency percentage for a data point in a series in a DirectX 3D graph.

SetDetailHeight

Integer

Sets the height of each row in a specified range.

SetFilter

Integer

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

SetFocus

Integer

Sets focus to the DataWindow control.

SetFormat

Integer

Sets the display format for the specified column of the DataWindow control.

SetFullState

Long

Applies the contents of a DataWindow blob retrieved by GetFullState to a DataWindow. This function is used primarily in distributed applications.

SetHTMLAction

Integer

Accepts action and context information about user interaction with the Web DataWindow client control in a Web browser so that newly generated HTML can reflect any requested changes.

Obsolete function

SetHTMLAction is an obsolete function, because Web DataWindow technology is obsolete.

SetItem

Integer

Sets the value of the specified row and column of the specified DataWindow control.

SetItemStatus

Integer

Sets the status of a row in a specified column of the DataWindow control in the specified buffer.

SetPosition

Integer

Syntax 1: Specifies whether the DataWindow control always displays on top in the front-to-back order within the window.

Syntax 2: Moves an object within the DataWindow to another band or changes the front-to-back order of objects within a band.

SetRedraw

Integer

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

SetRow

Integer

Makes the specified row the current row in the DataWindow control.

SetRowFocusIndicator

Integer

Sets the current row indicator for the DataWindow control.

SetSeriesLabelling

Integer

Sets the series label for a DirectX 3D graph.

SetSeriesStyle

Integer

For the specified series in the specified graph in the DataWindow control:

Syntax 1: Sets the series color.

Syntax 2: Sets the linestyle and width.

Syntax 3: Sets the fill pattern or symbol for data markers in the series.

Syntax 4: Specifies that the series is an overlay.

SetSort

Integer

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

SetSeriesTransparency

Integer

Sets the transparency percentage of a series in a DirectX 3D type graph.

SetSQLPreview

Integer

Sets the current SQL statement for the DataWindow control.

SetSQLSelect

Integer

Changes the current SELECT statement for the DataWindow control.

SetTabOrder

Integer

Changes the tab value of the specified column in the DataWindow control.

SetText

Integer

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

SetTrans

Integer

Sets values in the DataWindow control's internal Transaction object.

SetTransObject

Integer

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

SetValidate

Integer

Changes the validation rule used for the specified column of the DataWindow control.

SetValue

Integer

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

SetWSObject

Integer

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

ShareData

Integer

Shares data between a primary DataWindow control and a secondary DataWindow control.

ShareDataOff

Integer

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

Show

Integer

Makes the DataWindow control visible.

ShowHeadFoot

Integer

In a RichText presentation style DataWindow control, displays the panels for editing the header and footer or hides the panels and returns to editing the main text.

Sort

Integer

Sorts the rows of the DataWindow control based on its current sort criteria.

TextLine

String

Reports information about the edit control over the current row and column.

TriggerEvent

Integer

Triggers a specified event in the DataWindow control and executes the script for the event.

TypeOf

Object

Returns the type of the control.

Undo

Integer

Cancels the last edit in the edit control over the current row and column.

Update

Integer

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