Properties for PowerBuilder DataWindow

These properties are also documented in the Objects and Controls.

Properties for DataStore objects

You can set properties of a DataStore object in code using dot notation.

DataStore property

Datatype

Description

DataObject

String

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

ClassDefinition

PowerObject

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

Object

DWObject

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

For information, see Accessing Data in Code and Accessing DataWindow Object Properties in Code.


Properties for DataWindow controls

You can set properties of a DataWindow control in the window or user object painter or in code.

DataWindow property

Datatype

Description

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 or Report 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 manually put the control into Drag Mode 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 controls within a DataWindow object from a script. These controls could be, for example, columns or text controls.

For information, see Accessing Data in Code and Accessing DataWindow Object Properties in Code.

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 a Hebrew or Arabic version of PowerBuilder under 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.