DataWindow Reference DataWindow Object Properties

DispAttr.fontproperty

Description

Settings for the appearance of various text components of a graph.

Applies to

Properties of Graph controls, as noted throughout this discussion

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.property.DispAttr.fontproperty

Describe and Modify argument:

"graphname.property.DispAttr.fontproperty { = value }"

Parameter	Description
graphname	The Graph control in a DataWindow for which you want to get or set font appearance values.
property	A text component of the graph, such as an Axis keyword (Category, Series, or Values), Legend, Pie, or Title, specifying the graph component whose appearance you want to get or set. These properties have their own entries. These values are listed in the following table. You can also set font properties for the label of an axis with the following syntax: "graphname.axis.LabelDispAttr.fontproperty { = value }"
fontproperty	A property that controls the appearance of text in the graph. Properties and their settings are listed in the table below.
value	The value to be assigned to fontproperty. Value can be a quoted DataWindow expression.

Property for DispAttr	Value
Alignment	(exp) The alignment of the text. Values are: 0 -- Left 1 -- Right 2 -- Center Painter: Alignment option. Alignment for axis labels and text not supported by Render3D graph style.
AutoSize	(exp) Whether the text element should be autosized according to the amount of text being displayed. Values are: 0 -- Do not autosize 1 -- Autosize Painter: Autosize check box.
BackColor	(exp) A long value specifying the background color of the text. Painter: BackColor option.
DisplayExpression	An expression whose value is the label for the graph component. The default expression is the property containing the text for the graph component. The expression can include the text property and add other variable text. Painter: Display Expression option.
Font.CharSet	(exp) An integer specifying the character set to be used. Values are: 0 -- ANSI 1 -- The default character set for the specified font 2 -- Symbol 128 -- Shift JIS 255 -- OEM Painter: FontCharSet option.
Font.Escapement	(exp) An integer specifying the rotation for the baseline of the text in tenths of a degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal. Painter: Escapement option.
Font.Face	(exp) A string specifying the name of the font face, such as Arial or Courier. Painter: FaceName option.
Font.Family	(exp) An integer specifying the font family (Windows uses both face and family to determine which font to use). Values are: 0 -- AnyFont 1 -- Roman 2 -- Swiss 3 -- Modern 4 -- Script 5 -- Decorative Painter: Family option.
Font.Height	(exp) An integer specifying the height of the text in the unit of measure for the DataWindow. To specify size in points, specify a negative number. Not available when AutoSize is checked. Painter: Size option, specified in points.
Font.Italic	(exp) Whether the text should be italic. Values are: 0 -- Not italic (default) 1 -- Italic Painter: Italic option.
Font.Orientation	Same as Escapement.
Font.Pitch	(exp) The pitch of the font. Values are: 0 -- The default pitch for your system 1 -- Fixed 2 -- Variable Painter: Pitch option.
Font.Strikethrough	(exp) Whether the text should be crossed out. Values are: 0 -- Not crossed out (default) 1 -- Crossed out Painter: Strikeout option.
Font.Underline	(exp) Whether the text should be underlined. Values are: 0 -- Not underlined (default) 1 -- Underlined Painter: Underline option.
Font.Weight	(exp) An integer specifying the weight of the text, for example, 400 for normal or 700 for bold. Painter: Set indirectly using the Bold option.
Font.Width	(exp) An integer specifying the width of the font in the unit of measure specified for the DataWindow. Width is usually unspecified, which results in a default width based on the other properties. Painter: Width option.
Format	(exp) A string containing the display format for the text. Painter: Format option.
TextColor	(exp) A long specifying the color to be used for the text. Painter: TextColor option.

Usage

In the painter

Select the control and set values in the Properties view, Text tab. Settings apply to the selected item in the Text Object list box.

Examples

setting = dw1.Object.Category.LabelDispAttr.Font.Face
dw1.Object.Category.LabelDispAttr.Font.Face = "Arial"
setting =  &
   dw1.Describe("Category.LabelDispAttr.Font.Face")

dw1.Modify("gr_1.Category.LabelDispAttr.Font.Face= &
   'Arial'")
dw1.Modify("gr_1.Title.DispAttr.DisplayExpression=" &
   "'Title + ~"~n~" + Today()'")

DisplayType

Description

The way the OLE Object control displays the OLE object it contains. It can display an icon or an image of the object's contents. The image is reduced to fit inside the OLE container.

Both the icon and the image are provided by the OLE server. If the OLE server does not support a contents view, PowerBuilder displays an icon even if DisplayType is set to contents.

Applies to

OLE Object controls

Syntax

PowerBuilder dot notation:

dw_control.Object.olecontrolname.DisplayType

Describe and Modify argument:

"olecontrolname.DisplayType { = ' type ' }"

Parameter

Description

olecontrolname

The name of the OLE Object control for which you want to get or set the type of display.

type

A number specifying whether the user will see an icon or an image of the OLE object's contents. Type can be a quoted DataWindow expression.

Values are:

0 -- Icon

1 -- Content

Usage

In the painter

Select the control and set the value in the Properties view, Options tab.

Examples

string ls_data
ls_data = dw1.Object.ole_report.DisplayType
dw1.Object.ole_report.DisplayType = 1
ls_data = dw1.Describe("ole_report.DisplayType")
dw1.Modify("ole_report.DisplayType='1'")

Edit.property

Description

Settings that affect the appearance and behavior of columns whose edit style is Edit.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.Edit.property

Describe and Modify argument:

"columnname.Edit.property { = value }"

SyntaxFromSql:

Column ( Edit.property = value )

Parameter	Description
columnname	The column with the Edit edit style for which you want to get or set property values. You can specify the column name or a pound sign (#) and the column number.
property	A property for the column's Edit style. Properties and their settings are listed in the table below. The table identifies the properties you can use with SyntaxFromSql.
value	The value to be assigned to the property. For most Edit properties, you cannot specify a DataWindow expression. The exception is Edit.Format.

Property for Edit	Value
AutoHScroll	Whether the edit control scrolls horizontally automatically when data is entered or deleted. Values are: Yes -- Scroll horizontally automatically. No -- Do not scroll horizontally automatically. You can use AutoHScroll with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Horizontal Scroll option.
AutoSelect	Whether to select the contents of the edit control automatically when it receives focus. Values are: Yes -- Select automatically. No -- Do not select automatically. You can use AutoSelect with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Selection option.
AutoVScroll	Whether the edit box scrolls vertically automatically when data is entered or deleted. Values are: Yes -- Scroll vertically automatically. No -- Do not scroll vertically automatically. You can use AutoVScroll with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Vertical Scroll option.
Case	The case of the text in the edit control. Values are: Any -- Character of any case allowed. Upper -- Characters converted to uppercase. Lower -- Characters converted to lowercase. Painter: Case option.
CodeTable	Whether the column has a code table. Values are: Yes -- Code table defined. No -- No code table defined. Painter: Use Code Table option.
DisplayOnly	Whether the column is display only. Values are: Yes -- Do not allow the user to enter data; make the column display only. No -- (Default) Allow the user to enter data. Painter: Display Only option. For conditional control over column editing, use the Protect property.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) surrounds the current row of the column when the column has focus. Values are: Yes -- Display the focus rectangle. No -- Do not display the focus rectangle. You can use FocusRectangle with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Show Focus Rectangle option.
Format	(exp) A string containing the display format of the edit control. The value for Format is quoted and can be a DataWindow expression. Painter: Format option (do not use quotes around the value).
HScrollBar	Whether a horizontal scroll bar displays in the edit control. Values are: Yes -- Display the horizontal scroll bar. No -- Do not display the horizontal scroll bar. Painter: Horizontal Scroll Bar option.
Limit	A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited. Painter: Limit option.
Name	A string whose value is the name of the predefined edit style associated with the column. Named styles are defined in the Database painter and can be reused. Specifying a name that has not been previously defined associates the name with the column but does not define a new edit style. Painter: Style Name option.
NilIsNull	Whether to set the value of the edit control to null when the user leaves it blank. Values are: Yes -- Make the empty string null. No -- Do not make the empty string null. Painter: Empty String is Null option.
Password	Whether to assign secure display mode to the column. When the user enters characters, they display as asterisks (). Values are: Yes -- Assign secure display mode to the column. No -- Do not assign secure-display mode to the column. If you change the Password property, you should also change the Format property to display the results you want (for example, ****). Painter: Password option.
Required	Whether the column is required. Values are: Yes -- It is required. No -- It is not required. Painter: Required option.
Style	(Describe only) Returns the edit style of the column. Painter: Style Type option.
UseEllipsis	Whether an ellipsis (three dots) displays when a column with the Edit edit style contains character data that is too long for the display column in the DataWindow. The ellipsis does not display when the column has focus. Values are: Yes -- Truncate the data and add an ellipsis. No -- Truncate the data. Do not add an ellipsis. The property is ignored if you: Check Autosize Height on the Position page or set the Height.Autosize property in a script. Specify an expression for the Escapement property on the Font page or set the Font.Escapement property in a script to rotate the text. Painter: Use Ellipsis check box on the Format page.
ValidateCode	Whether the code table will be used to validate user-entered values. Values are: Yes -- Use the code table. No -- Do not use the code table. Painter: Validate option, available when Use Code Table is selected.
VScrollBar	Whether a vertical scroll bar displays in the line edit. Values are: Yes -- Display vertical scroll bars. No -- Do not display vertical scroll bars. Painter: Vertical Scroll Bar option.

Usage

In the painter

Select the control and set values in the Properties view, Edit tab, when Style Type is Edit.

Examples

string setting
setting = dw1.Object.emp_name.Edit.AutoHScroll
dw1.Object.emp_name.Edit.Required = "no"
setting = dw1.Describe("emp_name.Edit.AutoHScroll")
dw1.Modify("emp_name.Edit.Required=no")

dw1.Object.col1.Edit.UseEllipsis = Yes
dw1.Modify("col1.Edit.UseEllipsis=Yes")

EditMask.property

Description

Settings that affect the appearance and behavior of columns with the EditMask edit style.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.EditMask.property

Describe and Modify argument:

"columnname.EditMask.property { = value }"

Parameter	Description
columnname	The column with the EditMask edit style for which you want to get or set property values. You can specify the column name or a pound sign (#) and the column number.
property	A property for the column's EditMask style. Properties and their settings are listed in the table below.
value	The value to be assigned to the property. For EditMask properties, you cannot specify a DataWindow expression.

Property for EditMask	Value
AutoSkip	Whether the EditMask will automatically skip to the next field when the maximum number of characters has been entered. Values are: Yes -- Skip automatically. No -- Do not skip automatically. Painter: AutoSkip option.
CodeTable	Whether the column has a code table. Values are: Yes -- Code table defined. No -- No code table defined. Painter: Code Table option. When selected, Display Value and DataValue are displayed for specifying code table entries.
DDCalendar	Whether a drop-down calendar control displays when a user clicks in a column with a Date or DateTime edit mask. Values are: Yes -- Drop-down calendar control displays. No -- (Default) Drop-down calendar control does not display. Painter: Drop-down Calendar option.
DDCal_AlignRight	Whether the drop-down calendar is aligned with the right side of the column. Values are: Yes -- Column is right aligned. No -- (Default) Column is left aligned. Painter: Drop Align Right option on Other page.
DDCal_BackColor	The background color of the drop-down calendar. The default is Window Background. This property is not supported on the Windows 7/8.1/10 operating system. Painter: CalendarBackColor option on Other page.
DDCal_TextColor	The color of text in the drop-down calendar. The default is Window Text. This property is not supported on the Windows 7/8.1/10 operating system. Painter: CalendarTextColor option on Other page.
DDCal_TitleBackColor	The background color of the title in the drop-down calendar. The default is Highlight. This property is not supported on the Windows 7/8.1/10 operating system. Painter: CalendarTitleBackColor option on Other page.
DDCal_TitleTextColor	The color of text in the title of the drop-down calendar. The default is Highlight Text. This property is not supported on the Windows 7/8.1/10 operating system. Painter: CalendarTitleTextColor option on Other page.
DDCal_TrailingTextColor	The color of trailing text (days in the previous and next months) in the drop-down calendar. The default is Disabled Text. This property is not supported on the Windows 7/8.1/10 operating system. Painter: CalendarTrailingTextColor option on Other page.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) will surround the current row of the column when the column has focus. Values are: Yes -- (Default) Display the focus rectangle. No -- Do not display the focus rectangle. Painter: Show Focus Rectangle option.
Mask	A string containing the edit mask for the column. Painter: Mask option.
ReadOnly	Whether the column is read-only. This property is valid only if EditMask.Spin is set to Yes. Values are: Yes -- Do not allow the user to enter data; make the column read-only. No -- (Default) Allow the user to enter data. Painter: Read Only option.
Required	Whether the column is required. Values are: Yes -- It is required. No -- It is not required. Painter: Required option.
Spin	Whether the user can scroll through a list of possible values for the column with a spin control. Values are: Yes -- Display a spin control. No -- (Default) Do not display a spin control. Painter: Spin Control option.
SpinIncr	An integer indicating the amount to increment the spin control's values. The default for numeric values is 1; for dates, 1 year; and for time, 1 minute. Available for numeric, date, and time columns. For columns that are not numeric, date, or time, the spin control scrolls through values in an associated code table. If the EditMask.CodeTable property is No, the spin increment has no effect for these columns. Painter: Spin Increment option.
SpinRange	A string containing the maximum and minimum values for the column that will display in the spin control. The two values are separated by a tilde (~). This property is effective only if EditMaskSpin is True. Available for numeric, date, and time columns. Because the SpinRange string is within another quoted string, the tilde separator becomes four tildes in PowerBuilder, which reduces to a single tilde when parsed. The format for the string is: "EditMask.SpinRange = 'minval~~~~maxval ' " Painter: Spin Range group, Spin Min and Spin Max options.
UseEllipsis	Whether an ellipsis (three dots) displays when a column with the EditMask edit style contains character data that is too long for the display column in the DataWindow. The ellipsis does not display when the column has focus. Values are: Yes -- Truncate the data and add an ellipsis. No -- Truncate the data. Do not add an ellipsis. The property is ignored if you: Check Autosize Height on the Position page or set the Height.Autosize property in a script. Specify an expression for the Escapement property on the Font page or set the Font.Escapement property in a script to rotate the text. Painter: Use Ellipsis check box on the Format page.
UseFormat	Whether a Format Display mask is used for a column's display. A Format Display mask is used only when the column does not have focus. Values are: Yes -- Use a Format Display mask. No -- (Default) Do not use a Format Display mask. Painter: Use Format option.

Usage

In the painter

Select the control and set values in the Properties view, Edit tab, when Style is EditMask.

Examples

setting = dw1.Describe("emp_status.EditMask.Spin")
dw1.Modify("empBonus.EditMask.SpinIncr=1000")
dw1.Modify("empBonus.EditMask.SpinRange='0~~~~5000'")
string setting
setting = dw1.Object.emp_status.EditMask.Spin
dw1.Object.emp_bonus.EditMask.SpinIncr = 1000
dw1.Object.id.EditMask.SpinRange = "0~~~~10"
dw1.Object.col1.EditMask.UseEllipsis = Yes
dw1.Modify("col1.EditMask.UseEllipsis=Yes")

Elevation

Description

The elevation in a 3D graph.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Elevation

Describe and Modify argument:

"graphname.Elevation { = ' integer ' }"

Parameter	Description
graphname	The name of the graph control in the DataWindow for which you want to get or set the elevation.
integer	(exp) An integer specifying the elevation of the graph. Elevation can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Elevationscroll bar (enabled when a 3D graph type is selected).

Examples

string setting
setting = dw1.Object.graph_1.Elevation
dw1.Object.graph_1.Elevation = 35
setting = dw1.Describe("graph_1.Elevation")
dw1.Modify("graph_1.Elevation=35")
dw1.Modify("graph_1.Elevation='10~tIf(...,20,30)'")

EllipseHeight

Description

The radius of the vertical part of the corners of a RoundRectangle.

Applies to

RoundRectangle controls

Syntax

PowerBuilder dot notation:

dw_control.Object.rrectname.EllipseHeight

Describe and Modify argument:

"rrectname.EllipseHeight { = ' integer ' }"

Parameter	Description
rrectname	The name of the RoundRectangle control in the DataWindow for which you want to get or set the ellipse height.
integer	(exp) An integer specifying the radius of the vertical part of the corners of a RoundRectangle in the DataWindow's unit of measure. EllipseHeight can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

string setting
setting = dw1.Object.rrect_1.EllipseHeight
dw1.Object.rrect_1.EllipseHeight = 35
setting = dw1.Describe("rrect_1.EllipseHeight")
dw1.Modify("rrect_1.EllipseHeight=35")
dw1.Modify("rrect_1.EllipseHeight='10~tIf(...,20,30)'")

EllipseWidth

Description

The radius of the horizontal part of the corners of a RoundRectangle.

Applies to

RoundRectangle controls

Syntax

PowerBuilder dot notation:

dw_control.Object.rrectname.EllipseWidth

Describe and Modify argument:

"rrectname.EllipseWidth { = ' integer ' }"

Parameter	Description
rrectname	The name of the RoundRectangle control in the DataWindow for which you want to get or set the ellipse width.
integer	(exp) An integer specifying the radius of the horizontal part of the corners of a RoundRectangle in the DataWindow's unit of measure. EllipseWidth can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

string setting
setting = dw1.Object.rrect_1.EllipseWidth
dw1.Object.rrect_1.EllipseWidth = 35
setting = dw1.Describe("rrect_1.EllipseWidth")
dw1.Modify("rrect_1.EllipseWidth=35")
dw1.Modify("rrect_1.EllipseWidth='10~tIf(...,20,30)'")

Enabled

Description

Determines whether a control in a DataWindow is enabled.

Applies to

Button, Computed Field, Graph, InkPicture, OLE Database Blob, OLE Object, Picture, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.buttonname.Enabled

Describe and Modify argument:

"buttonname.Enabled { = ' value ' }"

Parameter

Description

buttonname

The name of the button that you want to enable or disable.

value

Whether the button is enabled.

Values are:

Yes -- (Default) The button is enabled.

No -- The button is disabled.

Usage

In the painter

Select the control and set the value in the Properties view General tab, Enabled option.

When the Enabled check box is cleared, or the Enabled property is otherwise set to false, the button control is grayed and its actions are not performed.

Examples

dw1.Object.b_name.Enabled = "No"
setting = dw1.Describe("b_name.Enabled")
dw1.Modify("b_name.Enabled ='No'")

Export.PDF.Distill.CustomPostScript

Description

Setting that enables you to specify the PostScript printer driver settings used when data is exported to PDF using the Distill! method.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.Distill.CustomPostScript

Describe and Modify argument:

"DataWindow.Export.PDF.Distill.CustomPostScript { = 'value' }"

Parameter

Description

value

(exp) Whether the printer specified in the DataWindow.Printer property is used when data is exported to PDF.

Values are:

1 -- The printer specified in DataWindow.Printer is used for PDF export.
0 -- The default printer is used for PDF export (default).

Usage

The Distill! method performs a PostScript "print to file" before distilling to PDF. This property can be set to specify that you want to use a custom PostScript printer before you call the SaveAs method with PDF! as the SaveAsType or select File>Save Rows As with the file type PDF in the DataWindow painter.

Set this property if you want to use a PostScript printer driver for which you have set specific print options such as options for font and graphic handling. If this property is not set, a default PostScript printer driver specifically designed for distilling purposes is used.

This property has no effect if the Export.PDF.Method property is set to NativePDF! or XSLFOP!.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select "PDF" from the Format to Configure list and "Distill!" from the Method list, and then select "Distill Custom PostScript".

Examples

This example specifies an HP LaserJet PostScript printer as the printer to be used to export PDF with customized settings, and saves the data to a file called custom.pdf:

int li_ret

dw1.Object.DataWindow.Export.PDF.Method = Distill!

dw1.Object.DataWindow.Printer = "HP LaserJet 4Si/4Si MX PostScript"
dw1.Object.DataWindow.Export.PDF.Distill.CustomPostScript="1"

li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to set the PDF export properties and specify a network printer:

dw1.Modify ("DataWindow.Export.PDF.Method = Distill!")
dw1.Modify ("Printer = '\\print-server\pr-18' ")
dw1.Modify ("DataWindow.Export.PDF.Distill.CustomPostScript = '1'")

See also

Export.PDF.Distill.CustomPostScript

Description

Setting that determines whether data is exported to PDF from a DataWindow object by printing to a PostScript file and distilling to PDF, by saving to PDF via PDFlib, or by saving in XSL Formatting Objects (XSL-FO) format and processing to PDF.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.Method

Describe and Modify argument:

"DataWindow.Export.PDF.Method { = 'value' }"

Parameter	Description
value	A string specifying a value of the PDFMethod enumerated datatype

Usage

This property can be set to specify the method used to export data to PDF before you call the SaveAs method with PDF! as the SaveAsType or select File>Save Rows As with the file type PDF in the DataWindow painter. If this property is not set, the distill method is used by default.

PDFMethod is an enumerated datatype that can hold the following values:

Enumerated value	Numeric value	Meaning
Distill!	0	Data is printed to a PostScript file and distilled to PDF (default).
XSLFOP!	1	Data is saved as XSL-FO and processed to PDF.
NativePDF!	2	Data is saved to PDF using PDFlib.

The distill method and the PDFlib method provides a robust solution that can save all types of DataWindow objects on the Windows platform. The XSL-FO method uses a platform-independent Java process, and is particularly useful for printing DataWindow objects in the server on a UNIX operating system.

Saving as XSL-FO

You can also save the data in a DataWindow object in XSL-FO format and customize the filters used to convert it to PDF and other output formats. To do so, use XSLFO! as the SaveAsType parameter when you call SaveAs, or select XSL-FO as the file type when you save rows in the DataWindow painter.

Deployment requirements

If your application uses the distill method, you must distribute the GNU Ghostscript files and default PostScript printer driver and related files (if using the default printer) with your application. If your application uses the XSL-FO method, you must distribute Apache FOP files and the Java Runtime Environment (JRE) with your application. For more information, see Deploying Applications and Components in Application Techniques.

In the painter

On the Data Export page in the Properties view for the DataWindow object, select "PDF" from the Format to Configure list and "Distill!", "NativePDF!", or "XSLFOP!" from the Method list.

Examples

This statement specifies that data is exported to PDF using XSL-FO:

dw1.Modify ("DataWindow.Export.PDF.Method = XSLFOP! ")

See also

Export.PDF.XSLFOP.Print

the section called “Saving the data as PDF” in Users Guide

Export.PDF.NativePDF.Author

Description

Setting that enables you to specify the author for the PDF file when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.Author

Describe argument:

"DataWindow.Export.PDF.NativePDF.Author { = 'value' }"

Parameter	Description
value	A string specifying the author for the PDF file.

Usage

In the painter

Input the author in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example specifies the author for the PDF file, and saves the data to a file called custom.pdf:

int li_ret
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.author = "Kate M."
dw1.Object.DataWindow.Export.PDF.NativePDF.subject = "Sales Data Report"
dw1.Object.DataWindow.Export.PDF.NativePDF.keywords = "Product A"
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to specify the author for the PDF file:

dw1.Modify("DataWindow.Export.PDF.NativePDF.Author =  'Kate M.'")

See also

Export.PDF.NativePDF.CustomOrientation

Description

Setting that enables you to specify the page orientation when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.CustomOrientation

Describe argument:

"DataWindow.Export.PDF.NativePDF.CustomOrientation { = 'value' }"

Parameter

Description

value

(exp) An integer indicating the page orientation.

Values are:

0 - The orientation which is set in the Print Specification page in the DataWindow object's Properties view.
1 - Landscape
2 - Portrait

Usage

In the painter

Select an orientation mode from the Orientation list in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example exports PDF in portrait mode, and saves the data to a file called custom.pdf:

int li_ret
dw1.Object.DataWindow.Export.PDF.NativePDF.UsePrintSpec = 'No'
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.CustomOrientation = '2'
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to export PDF in portrait mode:

dw1.Modify("DataWindow.Export.PDF.NativePDF.UsePrintSpec = No")
dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.CustomOrientation = '2'")

See also

Export.PDF.NativePDF.CustomSize

Description

Setting that enables you to specify the paper size when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.CustomSize

Describe argument:

"DataWindow.Export.PDF.NativePDF.CustomSize { = 'value' }"

Parameter

Description

value

(exp) An integer indicating the paper size.

Values are:

0 - Default paper size which is A4 by default.
1 - A1 594 x 841 mm
2 - A2 420 x 594 mm
3 - A3 297 x 420 mm
4 - A4 210 x 297 mm
5 - Letter 8 1/2 x 11 in
6 - Legal 8 1/2 x 14 in

Usage

In the painter

Select a size from the Paper Size list in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example exports PDF with A4 paper size, and saves the data to a file called custom.pdf:

int li_ret
dw1.Object.DataWindow.Export.PDF.NativePDF.UsePrintSpec = 'No'
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.CustomSize = '0'
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to set the PDF export properties:

dw1.Modify("DataWindow.Export.PDF.NativePDF.UsePrintSpec = No")
dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.CustomSize = '0'")

See also

Export.PDF.NativePDF.ImageFormat

Description

Setting that enables you to select a format for the embedded images in the PDF file when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.ImageFormat

Describe argument:

"DataWindow.Export.PDF.NativePDF.ImageFormat { = 'value' }"

Parameter

Description

value

(exp) An integer indicating the file format of the embedded images in the DataWindow object.

Values are:

0 - (Default) BMP
1 - JPG
2 - PNG
3 - GIF

The image format affects the speed of creating the PDF file and the size of the PDF file.

In the order from the fastest to the lowest: JPG, BMP, PNG, GIF

In the order from the smallest to the biggest: JPG, GIF, BMP, PNG

Examples

This example saves the embedded image as JPG format, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Export.PDF.NativePDF.ImageFormat = '1' //JPG
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the PDF print properties:

dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.ImageFormat = '1'")

See also

Export.PDF.NativePDF.Keywords

Description

Setting that enables you to specify the keywords for the PDF file when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.Keywords

Describe argument:

"DataWindow.Export.PDF.NativePDF.Keywords { = 'value' }"

Parameter	Description
value	A string specifying the keywords for the PDF file.

Usage

In the painter

Input the keywords in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example specifies the keywords for the PDF file, and saves the data to a file called custom.pdf:

int li_ret
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.keywords = "Product A"
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to specify the keywords for the PDF file:

dw1.Modify("DataWindow.Export.PDF.NativePDF.Keywords = 'Product A'")

See also

Export.PDF.NativePDF.MasterPassword

Description

Setting that enables you to set a password for changing the security settings and permissions (copy/print/edit/etc.) of the generated PDF file, when you use the PDFlib method to save data from a DataWindow object to a PDF file. Therefore, this master password is also referred to as owner or permissions password.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.MasterPassword

Describe argument:

"DataWindow.Export.PDF.NativePDF.MasterPassword { = 'value' }"

Parameter

Description

value

(exp) The password for the administration permissions of the generated PDF file.

The value can be a string containing at least one character or no more than 37 characters. If more than 37 characters are set, the first 37 characters will be used as the password. The characters must be printable ASCII characters. Any unprintable ASCII characters will cause PB dot notation to throw an exception.

Usage

Once you set the master password, the user with the master password automatically has the permission of opening the file and all other permissions (such as copying, printing, editing etc.) to the PDF file.

Once you set the master password, you can further control the access restrictions of the file, for example, restrict opening the file by setting the Export.PDF.NativePDF.UserPassword property, or restrict copying/printing/editing/etc. the file by setting the Export.PDF.NativePDF.Restrictions property. If the master password is empty, it indicates no master password or user password is required to open the file or copy/print/edit the file (which means any one can open the file and copy/print/edit the file with no restrictions).

The master password cannot be the same as the user password which is set by the Export.PDF.NativePDF.UserPassword property, otherwise SaveAs function will fail and return -1.

This property takes no effect for files created using PDF/A standard.

Examples

This example sets the user password and the master password, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Export.PDF.NativePDF.UserPassword = '123'
dw_1.Object.DataWindow.Export.PDF.NativePDF.MasterPassword = '456'
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the user password and the master password:

dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.UserPassword='123'")
dw1.Modify("DataWindow.Export.PDF.NativePDF.MasterPassword='456'")

See also

Export.PDF.NativePDF.PDFStandard

Description

Setting that enables you to select a PDF conformance level when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.PDFStandard

Describe argument:

"DataWindow.Export.PDF.NativePDF.PDFStandard { = 'value' }"

Parameter

Description

value

(exp) An integer indicating the level of PDF conformance.

Values are:

0 - None.
1 - PDF/A-1a
2 - PDF/A-1b
3 - PDF/A-3a
4 - PDF/A-3b
5 - PDF/A-3u

Usage

In the painter

Select a value from the PDF Conformance list in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example exports PDF using PDF/A-1a standard, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Export.PDF.NativePDF.PDFStandard = '1' //PDF/A-1a
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the PDF print properties:

dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.PDFStandard = '1'")

See also

Export.PDF.NativePDF.Restrictions

Description

Setting that enables you to specify the permission settings that restrict certain actions (such as copying/printing/editing) of the generated PDF file, when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.Restrictions

Describe argument:

"DataWindow.Export.PDF.NativePDF.Restrictions { = 'value' }"

Parameter

Description

value

(exp) The password for opening the generated PDF file.

The value can be a string containing one or more of the following values (separated by ","):

noprint! - Acrobat will prevent printing the file.
nohiresprint! - Acrobat will prevent high-resolution printing. If noprint is not set, printing is restricted to the print as image feature which prints a low-resolution rendition of the page.
nomodify! - Acrobat will prevent editing or cropping pages and creating or changing form fields.
noassemble! - Acrobat will prevent inserting, deleting, or rotating pages and creating bookmarks and thumbnails.
noannots! - Acrobat will prevent creating or changing annotations and form fields.
noforms! - Acrobat will prevent form field filling. (implies nomodify and noannots)
nocopy! - Acrobat will prevent copying and extracting text or graphics; the accessibility interface will be controlled by noaccessible.
noaccessible! - (Obsolete in PDF 2.0; not allowed in PDF/UA-1) Acrobat will prevent extracting text or graphics for accessibility
plainmetadata! - (PDF 1.5) Keep XMP document metadata unencrypted even in an encrypted document.

Usage

If you set the restrictions of the PDF file, you must also set the master password by the Export.PDF.NativePDF.MasterPassword property. There must be a value specified for the restriction property, otherwise syntax error may occur. If you do not want to set any restriction, please set Export.PDF.NativePDF.MasterPassword to empty, which indicates no master password or user password is required to open the file or copy/print/edit the file (which means any one can open the file and copy/print/edit the file with no restrictions).

If you set restrictions without setting the user password, a user can open the PDF file, and has the permissions specified by the restriction property.

This property takes no effect for files created using PDF/A standard.

Examples

This example prevents the PDF file being printed and copied, sets the master password, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Export.PDF.NativePDF.Restrictions = 'noprint!,nocopy!'
dw_1.Object.DataWindow.Export.PDF.NativePDF.MasterPassword = '456'
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the restrictions and the master password:

dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.Restrictions='noprint!,nocopy!'")
dw1.Modify("DataWindow.Export.PDF.NativePDF.MasterPassword='456'")

See also

Export.PDF.NativePDF.Subject

Description

Setting that enables you to specify the subject for the PDF file when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.Subject

Describe argument:

"DataWindow.Export.PDF.NativePDF.Subject { = 'value' }"

Parameter	Description
value	A string specifying the subject for the PDF file.

Usage

In the painter

Input the subject in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example specifies the subject for the PDF file, and saves the data to a file called custom.pdf:

int li_ret
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.author = "Kate M."
dw1.Object.DataWindow.Export.PDF.NativePDF.subject = "Sales Data Report"
dw1.Object.DataWindow.Export.PDF.NativePDF.keywords = "Product A"
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to specify the subject for the PDF file:

dw1.Modify("DataWindow.Export.PDF.NativePDF.Subject = 'Sales Data Report'")

See also

Export.PDF.NativePDF.UserPassword

Description

Setting that enables you to set a password for opening the generated PDF file, when you use the PDFlib method to save data from a DataWindow object to a PDF file. Therefore, this user password is also referred to as open password.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.UserPassword

Describe argument:

"DataWindow.Export.PDF.NativePDF.UserPassword { = 'value' }"

Parameter

Description

value

(exp) The password for opening the generated PDF file.

The value can be a string containing at least one character or no more than 37 characters. If more than 37 characters are set, the first 37 characters will be used as the password. The characters must be printable ASCII characters. Any unprintable ASCII characters will cause PB dot notation to throw an exception.

When the value is empty, it indicates no password is required to open the file.

Usage

If you set the user password for opening the PDF file, you must also set the master password by the Export.PDF.NativePDF.MasterPassword property. If the master password is empty, it indicates no master password or user password is required to open the file or copy/print/edit the file (which means any one can open the file and copy/print/edit the file with no restrictions).

If you set the user password without setting the restrictions, a user with the user password can open the PDF file for viewing only. You can use the Export.PDF.NativePDF.Restrictions property to set whether the user with the user password can have permissions of printing, copying, editing etc.

The user password and the master password cannot be the same, otherwise SaveAs function will fail and return -1.

If a PDF file requires a password to open, you can either input the user password or the master password. When inputting the user password, you will have the permissions set by the Export.PDF.NativePDF.Restrictions property; when inputting the master password, you automatically have access to all of the the permissions.

This property takes no effect for files created using PDF/A standard.

Examples

This example sets the user password and the master password, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Export.PDF.NativePDF.UserPassword = '123'
dw_1.Object.DataWindow.Export.PDF.NativePDF.MasterPassword = '456'
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the user password and the master password:

dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.UserPassword='123'")
dw1.Modify("DataWindow.Export.PDF.NativePDF.MasterPassword='456'")

See also

Export.PDF.NativePDF.UsePrintSpec

Description

Setting that enables you to use the page orientation and paper size settings in the Print Specifications tab or in the Print.Orientation and Print.Paper.Size properties, when you use the PDFlib method to save data from a DataWindow object to a PDF file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.NativePDF.UsePrintSpec

Describe argument:

"DataWindow.Export.PDF.NativePDF.UsePrintSpec { = 'value' }"

Parameter

Description

value

(exp) Whether to use the settings in the print specifications or not.

Values are:

Yes - Use the settings in the Print Specifications page or in the Print.Orientation and Print.Paper.Size properties.
No - (Default) Use the settings in the Data Export page or in the Export.PDF.NativePDF.CustomOrientation and Export.PDF.NativePDF.CustomSize properties.

Usage

In the painter

Select the "Use Paper Size and Orientation Settings from Print Specifications" checkbox in the Data Export tab in the Properties view for the DataWindow object.

Examples

This example exports PDF with Letter paper size in Landscape mode, and saves the data to a file called custom.pdf:

int li_ret
dw_1.Object.DataWindow.Export.PDF.NativePDF.UsePrintSpec = 'Yes'
dw_1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw_1.Object.DataWindow.Print.Orientation = '1' //Landscape!
dw_1.Object.DataWindow.Print.Paper.Size = '1' //1 – Letter 8 1/2 x 11 in
li_ret = dw_1.SaveAs("c:\custom.pdf",PDF!, true)

This example uses Modify to set the PDF print properties:

dw1.Modify("DataWindow.Export.PDF.NativePDF.UsePrintSpec = Yes")
dw1.Modify("DataWindow.Export.PDF.Method = NativePDF!")
dw1.Modify("DataWindow.Export.Print.Orientation = '1'")
dw1.Modify("DataWindow.Export.Print.Paper.Size = '1'")

See also

Export.PDF.XSLFOP.Print

Description

Setting that enables you to send a DataWindow object directly to a printer using platform-independent Java printing when using the XSL-FO method to export to PDF. This is an option of the Apache FOP processor.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.PDF.XSLFOP.Print

Describe argument:

"DataWindow.Export.PDF.XSLFOP.Print { = 'value' }"

Parameter

Description

value

(exp) Whether the exported PDF is sent directly to the default printer.

Values are:

Yes -- The DataWindow object is exported to a PDF file and sent directly to a printer.
No -- The DataWindow object is exported to a PDF file but is not printed (default).

Usage

Set this property if you are using the XSL-FO method to export a DataWindow object to a PDF file and you want to send the PDF file directly to a printer. The PDF file is always printed to the default system printer. The DataWindow.Printer property setting is ignored.

This property has no effect if the Export.PDF.Method property is set to NativePDF! or Distill!.

In the painter

On the Data Export page in the Properties view for the DataWindow object, select PDF from the Format to Configure list and XSLFOP! from the Method list, and then select Print Using XSLFOP.

Examples

This example specifies the XSLFOP! method for PDF export, sets the XSLFOP.Print property, and saves the data to a file called printed.pdf, which is sent directly to the default printer:

int li_ret

dw1.Object.DataWindow.Export.PDF.Method = XSLFOP!
dw1.Object.DataWindow.Export.PDF.xslfop.print='Yes'
li_ret = dw1.SaveAs("printed.pdf", PDF!, true)

See also

Export.XHTML.Template[ ].Name

Export.XHTML.TemplateCount

Description

The number of XHTML export templates associated with a DataWindow object.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XHTML.TemplateCount

Describe argument:

"DataWindow.Export.XHTML.TemplateCount"

Usage

This property is used to get a count of the XHTML export templates associated with a DataWindow object. It returns a long specifying the number of XHTML export templates previously saved in the DataWindow painter for the specified DataWindow object. The count is used with the DataWindow.Export.XHTML.Template[ ].Name property to enable an application to select an export template at runtime.

Examples

This code in the open event of a window uses the TemplateCount property to get the number of templates associated with dw1. It then uses the number returned as the upper limit in a FOR loop that populates a drop-down list box with the template names, using the DataWindow.Export.XHTML.Template[ ].Name property.

string ls_template_name
long l_template_count, i

l_template_count = Long &
   (dw1.Object.DataWindow.Export.XHTML.TemplateCount)

for i=1 to l_template_count)
  ls_template_name = &
  dw1.Object.DataWindow.Export.XHTML.Template[i].Name  ddlb_1.AddItem(ls_template_name)
next

Before generating the XHTML, set the export template using the text in the drop-down list box:

dw1.Object.DataWindow.Export.XHTML.UseTemplate = ddlb_1.text

See also

Export.XHTML.UseTemplate

Export.XHTML.Template[ ].Name

Description

The name of an XHTML export template associated with a DataWindow object.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XHTML.Template[ num ].Name

Describe argument:

"DataWindow.Export.XHTML.Template[ num ]Name"

Parameter	Description
num	(exp) A long specifying the index of the export template

Usage

This property returns the names of the XHTML export templates associated with a DataWindow object by index. The index can range from 1 to the value of the DataWindow.Export.XHTML.TemplateCount property. The order reflects the serialized storage order of all templates, which is a read-only setting. These properties, with DataWindow.Export.XHTML.UseTemplate, enable an application to select an export template dynamically at runtime.

Examples

See Export.XHTML.TemplateCount.

See also

Export.XHTML.TemplateCount

Export.XHTML.UseTemplate

Description

Setting that optionally controls the logical structure of the XHTML generated by a DataWindow object from a DataWindow data expression using dot notation.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XHTML.UseTemplate

Describe and Modify argument:

"DataWindow.Export.XHTML.UseTemplate { = 'value ' }"

Parameter	Description
value	(exp) A string specifying the name of an XHTML export template previously saved in the DataWindow painter for the specified DataWindow object

Usage

This property uses a template defined in the DataWindow painter to specify the logical structure and attribute overrides that PowerBuilder should use to generate XHTML from a DataWindow object. It is designed to be used with the data expression for the DataWindow object, and should be set before a data expression statement.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XHTML from the Format to Configure list and select a template from the Use Template list.

Examples

This example stores the name of the export template used in dw1 in the string ls_template. If no template is selected in dw1, an empty string is returned.

string ls_template_name
ls_template_name = dw1.Describe ("DataWindow.Export.XHTML.UseTemplate")

This example sets the name of the current XHTML export template used in dw1 to t_report. If t_report does not exist, the current template is not changed.

dw1.Modify("DataWindow.Export.XHTML.UseTemplate = 't_report' ")

See also

Export.XHTML.TemplateCount

Export.XHTML.Template[ ].Name

Export.XML.HeadGroups

Description

Setting that causes elements, attributes, and all other items above the Detail Start element in an XML export template for a group DataWindow to be iterated for each group in the exported XML.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.HeadGroups

Describe and Modify argument:

"DataWindow.Export.XML.HeadGroups { = 'value ' }"

Parameter

Description

value

(exp) Whether the contents of the header section in an export template iterate in the generated XML.

Values are:

Yes -- The header section is repeated for each group (default).
No -- The header section is not repeated.

Usage

This property must be set for group DataWindow objects if you want elements and other items added to the header section of an XML export template to be repeated before each group in the exported XML. For DataWindow objects with multiple groups, each XML fragment in the header section between a Group Header element and the next Group Header element or Detail Start element is iterated.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select Iterate header for Groups.

Examples

dw1.Object.DataWindow.Export.XML.HeadGroups = "Yes"
dw1.Modify("DataWindow.Export.XML.HeadGroups = 'No' ")

Export.XML.IncludeWhitespace

Description

Setting that determines whether the XML document is formatted by inserting whitespace characters (carriage returns, linefeeds, tabs, and spacebar spaces).

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.IncludeWhitespace

Describe and Modify argument:

"DataWindow.Export.XML.IncludeWhitespace { = 'value ' }"

Parameter

Description

value

(exp) Whether the generated XML is formatted with whitespace characters.

Values are:

Yes -- Whitespace characters are inserted.
No -- Whitespace characters are not inserted (default).

Usage

This property should be set before you export a DataWindow object if you want to view or verify the exported XML using a text editor.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select Include Whitespace.

Examples

dw1.Object.DataWindow.Export.XML.IncludeWhitespace = "No"
dw1.Modify("DataWindow.Export.XML.IncludeWhitespace = 'Yes' ")

Export.XML.MetaDataType

Description

Setting that controls the type of metadata generated with the XML exported from a DataWindow object using the SaveAs method or a .Data.XML expression.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.MetaDataType

Describe and Modify argument:

"DataWindow.Export.XML.MetaDataType { = 'value ' }"

Parameter	Description
value	(exp) A string specifying a value of the Export.XML.MetaDataType enumerated datatype

Usage

This property must be set to specify the type of metadata generated before you call the SaveAs method with XML! as the SaveAsType to save data as an XML document, or use the .Data.XML expression to save data as an XML string. The metadata is saved into the exported XML itself or into an associated file, depending on the value of the Export.XML.SaveMetaData property.

The Export.XML.MetaDataType property is an enumerated datatype that can hold the following values:

Enumerated value	Numeric value	Meaning
XMLNone!	0	Metadata (XML Schema or DTD) is not generated when XML is exported
XMLSchema!	1	XML Schema is generated when XML is exported
XMLDTD!	2	DTD is generated when XML is exported

If the data item for a column is null or an empty string, an empty element is created when you export XML. If you select XMLSchema!, child elements with null data items are created with the content "xsi:nil='true'".

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select a value from the Meta Data Type list.

Examples

This statement specifies that no metadata will be generated when the DataWindow is exported to XML:

dw1.Object.DataWindow.Export.XML.MetaDataType = XMLNone!

These statements export the contents of dw1 to the file c:\myxml.xml using the XML export template called t_schema, and generate an external XML schema file at c:\myxml.xsd:

dw1.Modify("DataWindow.Export.XML.UseTemplate = 't_schema'")
dw1.Modify("DataWindow.Export.XML.MetaDataType = 1")
dw1.Modify("DataWindow.Export.XML.SaveMetaData = 1")
dw1.SaveAs("c:\myxml.xml", XML!, false)

See also

Export.XML.SaveMetaData

Description

Setting that controls the storage format for the metadata generated with the XML exported from a DataWindow object using the SaveAs method or a .Data.XML expression.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.SaveMetaData

Describe and Modify argument:

"DataWindow.Export.XML.SaveMetaData { = 'value ' }"

Parameter	Description
value	(exp) A string specifying a value of the Export.XML.SaveMetaData enumerated datatype

Usage

This property must be set to specify how to store the generated metadata before you call the SaveAs method with XML! as the SaveAsType to save data as an XML document, or use the .Data.XML expression to save data as an XML string. The metadata can be saved into the exported XML document or string or into an associated file.

Note

If Export.XML.MetaDataType is set to XMLNone!, the value of the Export.XML.SaveMetaData property is not used.

The Export.XML.SaveMetaData property is an enumerated datatype that can hold the following values:

Enumerated value

Numeric value

Meaning

MetaDataInternal!

0

The metadata is saved into the generated XML document or string. To save metadata using the .Data.XML expression syntax, you must use this value.

MetaDataExternal!

1

With the SaveAs method, metadata is saved as an external file with the same name as the XML document but with the extension .xsd (for XMLSchema! type) or .dtd (for XMLDTD! type). A reference to the name of the metadata file is included in the output XML document.

With .Data.XML, no metadata is generated in the XML string.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select a value from the Save Meta Data list.

Examples

dw1.Object.DataWindow.Export.XML.SaveMetaData = 0
dw1.Modify("DataWindow.Export.XML.SaveMetaData = &
   MetaDataExternal!")

See also

Export.XML.MetaDataType

Export.XML.TemplateCount

Description

The number of XML export templates associated with a DataWindow object.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.TemplateCount

Describe argument:

"DataWindow.Export.XML.TemplateCount"

Usage

This property is used to get a count of the XML export templates associated with a DataWindow object. It returns a long specifying the number of XML export templates previously saved in the DataWindow painter for the specified DataWindow object. The count is used with the DataWindow.Export.XML.Template[ ].Name property to enable an application to select an export template at runtime.

Examples

This code in the open event of a window uses the TemplateCount property to get the number of templates associated with dw1. It then uses the number returned as the upper limit in a FOR loop that populates a drop-down list box with the template names, using the DataWindow.Export.XML.Template[ ].Name property.

string ls_template_count, ls_template_name
long i

ls_template_count = dw1.Describe ("DataWindow.Export.XML.TemplateCount")

for i=1 to Long(ls_template_count)
  ls_template_name = dw1.Object.DataWindow.Export.XML.Template[i].Name
  ddlb_1.AddItem(ls_template_name)
next

Before generating the XML, set the export template using the text in the drop-down list box:

dw1.Object.DataWindow.Export.XML.UseTemplate = ddlb_1.text

See also

Export.XML.Template[ ].Name

Export.XML.UseTemplate

Export.XML.Template[ ].Name

Description

The name of an XML export template associated with a DataWindow object.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.Template[num ].Name

Describe argument:

"DataWindow.Export.XML.Template[num ]Name"

Parameter	Description
num	(exp) A long specifying the index of the export template

Usage

This property is used to get the names of the XML export templates associated with a DataWindow object. It returns a string specifying the name of an export template previously saved in the DataWindow painter for the specified DataWindow object. The property is used with the DataWindow.Export.XML.TemplateCount property to enable an application to select an export template at runtime.

Examples

See Export.XML.TemplateCount.

See also

Export.XML.TemplateCount

Export.XML.UseTemplate

Description

Setting that optionally controls the logical structure of the XML exported from a DataWindow object using the SaveAs method or the .Data.XML property.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Export.XML.UseTemplate

Describe and Modify argument:

"DataWindow.Export.XML.UseTemplate { = 'value ' }"

Parameter	Description
value	(exp) A string specifying the name of an export template previously saved in the DataWindow painter for the specified DataWindow object

Usage

This property should be set to specify the logical structure of the XML generated before you call the SaveAs method with XML! as the SaveAsType to save data as an XML document, or use the .Data.XML expression to save data as an XML string.

In the painter

In the Data Export tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select a template from the Use Template list.

Examples

This example stores the name of the export template used in dw1 in the string ls_template. If no template is selected in dw1, an empty string is returned.

string ls_template_name
ls_template_name = dw1.Describe("DataWindow.Export.XML.UseTemplate")

This example sets the name of the current XML export template used in dw1 to t_report. If t_report does not exist, the current template is not changed.

dw1.Modify("DataWindow.Export.XML.UseTemplate = 't_report' ")

See also

Export.XML.MetaDataType

Export.XML.SaveMetaData

Expression

Description

The expression for a computed field control in the DataWindow. The expression is made up of calculations and DataWindow expression functions. The DataWindow evaluates the expression to get the value it will display in the computed field.

Applies to

Computed field controls

Syntax

PowerBuilder dot notation:

dw_control.Object.computename.Expression

Describe and Modify argument:

"computename.Expression { = 'string' }"

Parameter	Description
computename	The name of the computed field control in the DataWindow for which you want to get or set the expression
string	A string whose value is the expression for the computed field

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Expression option. The More button displays the Modify Expression dialog, which provides help in specifying the expression. The Verify button tests the expression.

Examples

setting = dw1.Object.comp_1.Expression
dw1.Object.comp_1.Expression = "avg(salary for all)"
setting = dw1.Describe("comp_1.Expression")
dw1.Modify("comp_1.Expression='avg(salary for all)'")

Filename

Description

The file name containing the image for a Picture or Button control in the DataWindow. If no image is specified for a Button control, only text is used for the button label.

Applies to

Picture and Button controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Filename

Describe and Modify argument:

"controlname.Filename { = ' filestring' }"

Parameter

Description

controlname

The name of the Picture or Button control in the DataWindow for which you want to get or set the image file name.

filestring

(exp) A string containing the name of the file that contains the image. Filestring can be a quoted DataWindow expression.

Button pictures can be BMP, GIF, or JPEG files. You can use a URL instead of a full path name, and if you set the HTMLGen.ResourceBase property to the URL address, you need to specify only a relative file name for this string.

If you include the name of the file containing the image in the executable for the application, PowerBuilder will always use that image; you cannot use Modify to change the image.

Usage

In the painter

For a Picture control, select the control and set the value in the Properties view, General tab, File Name option. For a Button control, select the control and set the value in the Properties view, General tab, Picture File option. The Action Default Picture check box must be cleared to set the value for the picture file.

Examples

Example for a Picture control:

setting = dw1.Object.bitmap_1.Filename
dw1.Object.bitmap_1.Filename = "exclaim.bmp"
setting = dw1.Describe("bitmap_1.Filename")
dw1.Modify("bitmap_1.Filename='exclaim.bmp'")

Example for a Button control:

dw1.Object.b_name.FileName = "logo.gif"
ls_data = dw1.Describe("b_name.FileName")
dw1.Modify("b_name.FileName = 'logo.jpg'")

See also

DefaultPicture

FirstRowOnPage

Description

The first row currently visible in the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.FirstRowOnPage

Describe argument:

"DataWindow.FirstRowOnPage"

Examples

string setting
setting = dw1.Object.DataWindow.FirstRowOnPage
setting = dw1.Describe("DataWindow.FirstRowOnPage")

FocusRectangle

Description

Whether a rectangle displays around the selected control.

Applies to

Column, Computed Field, Graph, OLE Object, OLE Database Blob, Picture, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.FocusRectangle

Describe and Modify argument:

"controlname.FocusRectangle = value"

Parameter	Description
controlname	The name of the control for which you want to show or hide the focus rectangle
value	Whether the focus rectangle appears when the control has focus. Values are: Yes -- The focus rectangle displays No -- The focus rectangle does not display

Usage

In the painter

Select the control and set the value in the Properties view, Edit tab, Show Focus Rectangle option.

Examples

String ls_DataObject
string ls_focus, ls_focus1
 
ls_DataObject= dw_1.DataObject
If ls_DataObject = "d_dept" Then
   dw_1.Modify("t_1.focusrectangle = " + "yes")
   ls_focus = dw_1.describe("t_1.focusrectangle")
   ls_focus1 = dw_1.object.t_1.focusrectangle
Else
   dw_1.Modify("gr_1.focusrectangle = " + "yes")
   ls_focus = dw_1.describe("gr_1.focusrectangle")
   ls_focus1 = dw_1.object.gr_1.focusrectangle
End If
 
messagebox(ls_focus, ls_focus1)

Font.Bias

Description

The way fonts are manipulated in the DataWindow at runtime.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Font.Bias

Describe and Modify argument:

"DataWindow.Font.Bias { = biasvalue }"

Parameter

Description

biasvalue

An integer indicating how the fonts will be manipulated at execution. Biasvalue cannot be a DataWindow expression.

Values are:

0 -- As display fonts

1 -- As printer fonts

2 -- Neutral; no manipulation will take place

Examples

string setting
setting = dw1.Object.DataWindow.Font.Bias
dw1.Object.DataWindow.Font.Bias = 1
setting = dw1.Describe("DataWindow.Font.Bias")
dw1.Modify("DataWindow.Font.Bias=1")

Font.property

Description

Settings that control the appearance of fonts within a DataWindow, except for graphs, which have their own settings (see DispAttr).

Applies to

Button, Column, Computed Field, GroupBox, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Font.property

Describe and Modify argument:

"controlname.Font.property { = ' value ' }"

SyntaxFromSql:

   Column(Font.property = value)
   Text(Font.property = value)

Parameter

Description

controlname

The name of a column, computed field, or text control for which you want to get or set font properties. For a column, you can specify the column name or a pound sign (#) followed by the column number.

When you generate DataWindow syntax with SyntaxFromSql, the Font settings apply to all columns or all text controls.

property

A property of the text. The properties and their values are listed in the table below.

value

The value to be assigned to the property. Value can be a quoted DataWindow expression.

Property for Font	Value
CharSet	(exp) An integer specifying the character set to be used. Values are: 0 -- ANSI 1 -- The default character set for the specified font 2 -- Symbol 128 -- Shift JIS 255 -- OEM Painter: Font tab, CharSet option.
Escapement	(exp) An integer specifying the rotation for the baseline of the text in tenths of a degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal. Painter: Font tab, Escapement option.
Face	(exp) A string specifying the name of the font face, such as Arial or Courier. Painter: Font tab, FaceName option or StyleBar.
Family	(exp) An integer specifying the font family (Windows uses both face and family to determine which font to use). Values are: 0 -- AnyFont 1 -- Roman 2 -- Swiss 3 -- Modern 4 -- Script 5 -- Decorative Painter: Font tab, Family option.
Height	(exp) An integer specifying the height of the text in the unit measure for the DataWindow. To specify size in points, specify a negative number. Painter: Font tab, Size option (specified in points) or StyleBar or Expressions tab.
Italic	(exp) Whether the text should be italic. The default is no. Painter: Font tab, Italic check box or StyleBar.
Pitch	(exp) The pitch of the font. Values are: 0 -- The default pitch for your system 1 -- Fixed 2 -- Variable Painter: Font tab, Pitch option.
Strikethrough	(exp) Whether the text should be crossed out. The default is no. Painter: Font tab, Strikeout check box.
Underline	(exp) Whether the text should be underlined. The default is no. Painter: Font tab, Underline check box or StyleBar.
Weight	(exp) An integer specifying the weight of the text; for example, 400 for normal or 700 for bold. Painter: Set indirectly using the Font tab, Bold option or the StyleBar, Bold button.
Width	(exp) An integer specifying the average character width of the font in the unit of measure specified for the DataWindow. Width is usually unspecified, which results in a default width based on the other properties. Painter: Set indirectly using the font selection.

Usage

In the painter

Select the control and set the value using the:

Properties view, Font tab
For some font settings, StyleBar

Examples

dw1.Object.emp_name_t.Font.Face
dw1.Object.emp_name_t.Font.Face = "Arial"
dw1.Describe("emp_name_t.Font.Face")
dw1.Modify("emp_name_t.Font.Face='Arial'")

See also

Transparency (columns and controls)

Footer.property

Format

Description

The display format for a column.

You can use the GetFormat and SetFormat methods instead of Describe and Modify to get and change a column's display format. The advantage to using Modify is the ability to specify an expression.

Applies to

Column and Computed Field controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Format

Describe and Modify argument:

"controlname.Format { = ' value ' }"

Parameter	Description
controlname	The name of the column or computed field for which you want to get or set the display format.
value	(exp) A string specifying the display format. See the section called “Defining display formats” in Users Guide for information on constructing display formats. Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Format tab.

If you want to add text to a numeric display format and use a color attribute, you must include the escape character (\) before each literal in the mask. For example:

[red]\D\e\p\t\: ###

Examples

setting = dw1.Object.phone.Format
dw1.Object."phone.Format = "[red](@@@)@@@-@@@@;'None'"
setting = dw1.Describe("phone.Format")
dw1.Modify( &
"phone.Format='[red](@@@)@@@-@@@@;~~~'None~~~''")

See also

GetFormat function in the section called “GetFormat”

SetFormat function in the section called “SetFormat”

Gradient.property

Description

Settings that control the gradient display in a DataWindow object. Gradient display properties are not supported in RichText, Graph, or OLE DataWindow presentation styles.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.datawindow.gradient.property

Describe and Modify argument:

"DataWindow.gradient.property { = value }"

Parameter	Description
property	A property for the gradient. Properties and their settings are listed in the table that follows.
value	The value to be assigned to the property. For gradient properties, value can be a quoted DataWindow expression.

Property for Gradient	Value
Angle	An integer indicating the angle in degrees (values are 0 to 360) used to offset the color and transparency gradient. This property is used only when datawindow.brushmode takes values of 3 or 4. Painter: Background tab, Gradient group.
Color	The gradient color of the DataWindow. This property is only in effect when datawindow.brushmode takes values 1 through 5. Painter: Background tab, Gradient group
Focus	An integer in the range 0 to 100, specifying the distance (as a percentage) from the center where the background color is at its maximum. (For example, if the radial gradient is used and the value is set to 0, the color will be at the center of the background; if the value is set to 100, the color will be at the edges of the background.) Painter: Background tab, Gradient group
Repetition.Mode	Specifies the mode for determining the number of gradient transitions. Permitted values and their meanings are: 0 Gradient.repetition.count determines the number of gradient transitions 1 Gradient.repetition.length determines the number of gradient transitions Painter: Background tab, Gradient group.
Repetition.Count	An integer specifying the number of gradient transitions for background color and transparency. A value of 0 indicates 1 transition. A value of 3 indicates 4 transitions. This property is used only when the datawindow.brushmode property takes values from 1 to 4 and when the when the datawindow.gradient.repetition.mode value is 0 (by count). The maximum is 10,000. Painter: Background tab, Gradient group.
Repetition.Length	A long specifying the number of gradient transitions. This property is used only when the datawindow.brushmode property takes values from 1 to 4 and the datawindow.gradient.repetition.mode property takes the value of 1 (by length). The units for the length that you assign for gradient transitions are set by the datawindow.units property. Painter: Background tab, Gradient group.
Scale	An integer in the range 0 to 100 specifying the rate of transition to the gradient color (as a percentage). Painter: Background tab, Gradient group
Spread	An integer in the range 0 to 100 indicating the contribution of the second color to the blend (as a percentage). Painter: Background tab, Gradient group
Tranparency	An integer in the range 0 to 100, where 0 means that the secondary (gradient) background is opaque and 100 that it is completely transparent. The gradient defines transitions between the primary and secondary transparency settings. Painter: Background tab, Gradient group

Usage

In the painter

Select the DataWindow object and set the value on the Background tab of the Properties view.

If you save to an EMF or WMF, the properties on the Background tab are not saved with the DataWindow.

Examples

string ls_data
ls_data = dw_1.Object.datawindow.brushmode
dw_1.Object.datawindow.Brushmode = 5
ls_data = dw_1.Describe("datawindow.brushmode")
dw_1.Modify("datawindow.Brushmode=6")
dw_1.Modify("datawindow.Gradient.Transparency=75")

See also

Brushmode

Picture.property

GraphType

Description

The type of graph, such as bar, pie, column, and so on.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.GraphType

Describe and Modify argument:

"graphname.GraphType { = ' typeinteger ' }"

Parameter

Description

graphname

The graph control for which you want to get or change the type.

typeinteger

(exp) An integer identifying the type of graph in the DataWindow object. Typeinteger can be a quoted DataWindow expression.

Values are:

1 -- Area

2 -- Bar

3 -- Bar3D

4 -- Bar3DObj

5 -- BarStacked

6 -- BarStacked3DObj

7 -- Col

8 -- Col3D

9 -- Col3DObj

10 -- ColStacked

11 -- ColStacked3DObj

12 -- Line

13 -- Pie

14 -- Scatter

15 -- Area3D

16 -- Line3D

17 -- Pie3D

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

string setting
setting = dw1.Object.graph_1.GraphType
dw1.Object.graph_1.GraphType = 17
setting = dw1.Describe("graph_1.GraphType")
dw1.Modify("graph_1.GraphType=17")

Grid.ColumnMove

Description

Whether the user can rearrange columns by dragging.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Grid.ColumnMove

Describe and Modify argument:

"DataWindow.Grid.ColumnMove { = value } "

Parameter

Description

value

Whether the user can rearrange columns.

Values are:

Yes -- The user can drag columns.

No -- The user cannot drag columns.

Usage

In the painter

Select the DataWindow object by deselecting all controls; then set the value in the Properties view, General tab, Grid group, Column Moving check box (available when the presentation style is Grid, Crosstab, or TreeView with the Grid Style option selected).

Examples

string setting
setting = dw1.Object.DataWindow.Grid.ColumnMove
dw1.Object.DataWindow.Grid.ColumnMove = No
setting = dw1.Describe("DataWindow.Grid.ColumnMove")
dw1.Modify("DataWindow.Grid.ColumnMove=No")

Grid.Lines

Description

The way grid lines display and print in a DataWindow whose presentation style is Grid, Crosstab, or TreeView.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Grid.Lines

Describe and Modify argument:

"DataWindow.Grid.Lines { = value }"

Parameter

Description

value

An integer specifying whether grid lines are displayed on the screen and printed.

Values are:

0 -- Yes, grid lines are displayed and printed.

1 -- No, grid lines are not displayed and printed.

2 -- Grid lines are displayed, but not printed.

3 -- Grid lines are printed, but not displayed.

Usage

In the painter

Select the DataWindow object by deselecting all controls; then set the value in the Properties view, General tab, Grid group, Display option (available when the presentation style is Grid, Crosstab, or TreeView with the Grid Style option selected).

Examples

string setting
setting = dw1.Object.DataWindow.Grid.Lines
dw1.Object.DataWindow.Grid.Lines = 2
setting = dw1.Describe("DataWindow.Grid.Lines")
dw1.Modify("DataWindow.Grid.Lines=2")

GroupBy

Description

A comma-separated list of the columns or expressions that control the grouping of the data transferred from the DataWindow to the OLE object. When there is more than one grouping column, the first one is the primary group and the columns that follow are nested groups.

Applies to

OLE Object controls

Syntax

PowerBuilder dot notation:

dw_control.Object.olecontrolname.GroupBy

Describe and Modify argument:

"olecontrolname.GroupBy { = ' columnlist ' }"

Parameter	Description
olecontrolname	The name of the OLE Object control for which you want to get or set the grouping columns.
columnlist	(exp) A list of the columns or expressions that control the grouping. If there is more than one, separate them with commas. Columnlist can be a quoted DataWindow expression.

Usage

Target and Range also affect the data that is transferred to the OLE object.

In the painter

Select the control and set the value in the Properties view, Data tab, Group By option.

Examples

ls_data = dw1.Object.ole_report.GroupBy
dw1.Object.ole_report.GroupBy = "emp_state, emp_office"
dw1.Object.ole_report.GroupBy = "year"
ls_data = dw1.Describe("ole_report.GroupBy")
dw1.Modify("  &
   ole_report.GroupBy='emp_state, emp_office'")
dw1.Modify("ole_report.GroupBy='year'")

Header_Bottom_Margin

Description

The size of the bottom margin of the DataWindow's header area. Header_Bottom_Margin is meaningful only when type is Grid or Tabular.

Applies to

Style keywords

Syntax

SyntaxFromSql:

Style ( Header_Bottom_Margin = value )

Parameter	Description
value	An integer specifying the size of the bottom margin of the header area in the units specified for the DataWindow. The bottom margin is the distance between the bottom of the header area and the last line of the header.

Examples

SQLCA.SyntaxFromSQL(sqlstring, &
'Style(...Header_Bottom_Margin = 25 ...)', &
errstring)

Header_Top_Margin

Description

The size of the top margin of the DataWindow's header area. Header_Top_Margin is meaningful only when type is Grid or Tabular.

Applies to

Style keywords

Syntax

SyntaxFromSql:

Style ( Header_Top_Margin = value )

Parameter	Description
value	An integer specifying the size of the top margin of the header area in the units specified for the DataWindow. The top margin is the distance between the top of the header area and the first line of the header.

Examples

SQLCA.SyntaxFromSQL(sqlstring, &
'Style(...Header_Top_Margin = 500 ...)', errstring)

Header.property

Header.#.property

Height

Description

The height of a control in the DataWindow.

Applies to

Button, Column, Computed Field, Graph, GroupBox, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Height

Describe and Modify argument:

"controlname.Height { = ' value ' }"

Parameter	Description
controlname	The control within the DataWindow whose height you want to get or set.
value	(exp) An integer specifying the height of the control in the unit of measure specified for the DataWindow. Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab.

Examples

string setting
setting = dw1.Object.empname.Height
dw1.Object.empname.Height = 50
setting = dw1.Describe("empname.Height")
dw1.Modify("empname.Height=50")

Height.AutoSize

Description

Whether the control's width should be held constant and its height adjusted so that all the data is visible. This property is for use with read-only controls and printed reports. It should not be used with data entry fields or controls.

Applies to

Column, Computed Field, Report, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Height.AutoSize

Describe and Modify argument:

"controlname.Height.AutoSize { = value }"

Parameter

Description

controlname

The control for which you want to get or set the AutoSize property.

value

Whether the width or height of the control will be adjusted to display all the data. The height is limited to what can fit on the page.

Values are:

No -- Use the height defined in the painter.

Yes -- Calculate the height so that all the data is visible.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab, Autosize Height check box.

Minimum height

The height of the column, computed field, or text will never be less than the minimum height (the height selected in the painter).

When the band has Autosize Height set to true, you should avoid using the RowHeight DataWindow expression function to set the height of any element in the row. Doing so can result in a logical inconsistency between the height of the row and the height of the element. For more information, see the RowHeight function description.

Examples

string setting
setting = dw1.Object.empname.Height.AutoSize
dw1.Object.empname.Height.AutoSize = "Yes"
setting = dw1.Describe("empname.Height.AutoSize")
dw1.Modify("empname.Height.AutoSize=Yes")

See also

Bandname.property

Height.HasMinHeight

Description

Whether the column in a DataWindow object should maintain its minimum height, when its Autosize property is enabled. The property is false by default.

HasMinHeight only applies to columns that have Autosize enabled. When both Autosize height and HasMinHeight are true, the height value will be the max value between the auto height value (the calculated value when the Autosize height is set to true) and the value specified in the Height property.

Applies to

Column, Computed Field, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Height.HasMinHeight

Describe and Modify argument:

"controlname.Height.HasMinHeight { = value }"

Parameter

Description

controlname

The control for which you want to get or set the HasMinHeight property.

value

Whether the column should maintain its minimum height, when its Autosize property is enabled.

Values are:

No -- (default) Do not use the minimum height. If the Autosize property is enabled, the column that contains no data will be completely hidden.

Yes -- Use the minimum height (the height selected in the painter) for the column.

Usage

In the painter

Can be set only in code, not in the painter.

Examples

string setting
setting = dw1.Object.empname.Height.HasMinHeight
dw1.Object.empname.Height.AutoSize = "Yes"
dw1.Object.empname.Height.HasMinHeight = "Yes"
setting = dw1.Describe("empname.Height.HasMinHeight")
dw1.Modify("empname.Height.AutoSize=Yes")
dw1.Modify("empname.Height.HasMinHeight=Yes")

See also

Height.AutoSize

Help.property

Description

Settings for customizing the Help topics associated with DataWindow dialog boxes.

For more information about Help, see the section called “ShowHelp” in PowerScript Reference.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Help.property

Describe and Modify argument:

"DataWindow.Help.property { = value }"

Parameter	Description
property	A property for specifying DataWindow Help. Help properties and their settings are listed in the table below. The File property must have a valid file name before the rest of the Help property settings can become valid.
value	The value to be assigned to the property. For Help properties, value cannot be a DataWindow expression.

Property for Help	Value
Command	An integer specifying the type of Help command that is specified in the following TypeID properties. Values are: 0 -- Index 1 -- TopicID 2 -- Search keyword
File	A string containing the fully qualified name of the compiled Help file (for example, C:\proj\MYHELP.HLP). When this property has a value, Help buttons display on the DataWindow dialog boxes at runtime.
TypeID	A string specifying the default Help command to be used when a Help topic is not specified for the dialog using one of the following eight dialog-specific properties listed in this table.
TypeID.ImportFile	A string specifying the Help topic for the Import File dialog box, which might display when the ImportFile method is called in code.
TypeID.Retrieve.Argument	A string specifying the Help topic for the Retrieval Arguments dialog box, which displays when retrieval arguments expected by the DataWindow's SELECT statement are not specified for the Retrieve method in code.
TypeID.Retrieve.Criteria	A string specifying the Help topic for the Prompt for Criteria dialog box, which displays when the Criteria properties have been turned on for at least one column and the Retrieve method is called in code.
TypeID.SaveAs	A string specifying the Help topic for the Save As dialog box, which might display when the SaveAs method is called in code.
TypeID.SetCrosstab	A string specifying the Help topic for the Crosstab Definition dialog box, which might display when the CrosstabDialog method is called in code.
TypeID.SetFilter	A string specifying the Help topic for the Set Filter dialog box, which might display when the SetFilter and Filter methods are called in code.
TypeID.SetSort	A string specifying the Help topic for the Set Sort dialog box, which might display when the SetSort and Sort methods are called in code.
TypeID.SetSortExpr	A string specifying the Help topic for the Modify Expression dialog, which displays when the user double-clicks on a column in the Set Sort dialog.

Usage

In the painter

Can be set only in code, not in the painter.

Examples

string setting
setting = dw1.Object.DataWindow.Help.Command
dw1.Object.DataWindow.Help.File = "myhelp.hlp"
dw1.Object.DataWindow.Help.Command = 1
setting = dw1.Describe("DataWindow.Help.Command")
dw1.Modify("DataWindow.Help.File='myhelp.hlp'")
dw1.Modify("DataWindow.Help.Command=1")
dw1.Modify("DataWindow.Help.TypeID.SetFilter = 'filter_topic'")
dw1.Modify("DataWindow.Help.TypeID.Retrieve.Criteria = 'criteria_topic'")

HideGrayLine

Description

Shows or hides a gray line to indicate that a fixed page has been crossed when scrolling in a DataWindow with group headers.

Applies to

DataWindow control

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HideGrayLine

Describe and Modify argument:

"DataWindow.HideGrayLine { = 'value ' }"

Parameter

Description

value

(exp) Whether a gray line displays in the Preview view and at runtime.

Values are:

Yes -- The gray line is hidden.

No -- The gray line displays (default).

Value can be a quoted DataWindow expression.

Usage

This property can be set in the open event for the window in which the DataWindow displays. Note that you cannot suppress the display of repeating group headers.

In the painter

Select the DataWindow object by deselecting all controls; then set the value in the Properties view, General tab. This option is enabled only for DataWindows with group headers.

Examples

dw1.Object.DataWindow.HideGrayLine = yes

HideSnaked

Description

Whether the control appears only once per page when you print the DataWindow using the newspaper columns format.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Line, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.HideSnaked

Describe and Modify argument:

"controlname.HideSnaked { = ' value ' }"

Parameter

Description

controlname

The name of the control for which you want to get or set the HideSnaked setting.

value

(exp) Whether the control appears once or multiple times in the printed output when the output has multiple columns (like a newspaper).

Values are:

1 -- The control will appear only once on a page.

0 -- The control will appear in each column on a page.

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, HideSnaked check box.

Examples

string setting
setting = dw1.Object.graph_1.HideSnaked
dw1.Object.text_title.HideSnaked = "1"
setting = dw1.Describe("graph_1.HideSnaked")
dw1.Modify("text_title.HideSnaked=1")

Horizontal_Spread

Description

The space between columns in the detail area of the DataWindow object. Horizontal_Spread is meaningful only when type is Grid or Tabular.

Applies to

Style keywords

Syntax

SyntaxFromSql:

Style ( Horizontal_Spread = value )

Parameter	Description
value	An integer specifying the space between columns in the detail area of the DataWindow object area in the units specified for the DataWindow

Examples

SQLCA.SyntaxFromSQL(sqlstring, &
'Style(...Horizontal_Spread = 25 ...)', errstring)

HorizontalScrollMaximum

Description

The maximum width of the scroll box of the DataWindow's horizontal scroll bar. This value is set by PowerBuilder based on the layout of the DataWindow object and the size of the DataWindow control. Use HorizontalScrollMaximum with HorizontalScrollPosition to synchronize horizontal scrolling in multiple DataWindow objects.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HorizontalScrollMaximum

Describe argument:

"DataWindow.HorizontalScrollMaximum"

Examples

string setting
setting = dw1.Object.DataWindow.HorizontalScrollMaximum
setting = dw1.Describe("DataWindow.HorizontalScrollMaximum")

HorizontalScrollMaximum2

Description

The maximum width of the second scroll box when the horizontal scroll bar is split (HorizontalScrollSplit is greater than 0). This value is set by PowerBuilder based on the content of the DataWindow. Use HorizontalScrollMaximum2 with HorizontalScrollPosition2 to synchronize horizontal scrolling in multiple DataWindow objects.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HorizontalScrollMaximum2

Describe argument:

"DataWindow.HorizontalScrollMaximum2"

Examples

string setting
setting = dw1.Object.DataWindow.HorizontalScrollMaximum2
setting = dw1.Describe("DataWindow.HorizontalScrollMaximum2")

HorizontalScrollPosition

Description

The position of the scroll box in the horizontal scroll bar. Use HorizontalScrollMaximum with HorizontalScrollPosition to synchronize horizontal scrolling in multiple DataWindow objects.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HorizontalScrollPosition

Describe and Modify argument:

"DataWindow.HorizontalScrollPosition { = scrollvalue }"

Parameter	Description
scrollvalue	An integer specifying the position of the scroll box in the horizontal scroll bar of the DataWindow

Examples

string spos1
spos1 = dw1.Object.DataWindow.HorizontalScrollPosition
string smax1, smax2, spos1, modstring
integer pos2
smax1 = dw1.Describe( &
"DataWindow.HorizontalScrollMaximum")
spos1 = dw1.Describe( &
"DataWindow.HorizontalScrollPosition")
smax2 = dw_2.Describe( &
"DataWindow.HorizontalScrollMaximum")
pos2 = Integer(spos1) * Integer(smax2) / Integer(smax1)
modstring = "DataWindow.HorizontalScrollPosition=" &
+ String(pos2)
dw1.Modify(modstring)

HorizontalScrollPosition2

Description

The position of the scroll box in the second portion of the horizontal scroll bar when the scroll bar is split (HorizontalScrollSplit is greater than 0). Use HorizontalScrollMaximum2 with HorizontalScrollPosition2 to synchronize horizontal scrolling in multiple DataWindow objects.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HorizontalScrollPosition2

Describe and Modify argument:

"DataWindow.HorizontalScrollPosition2 { = scrollvalue }"

Parameter	Description
scrollvalue	An integer specifying the position of the scroll box in the second portion of a split horizontal scroll bar of the DataWindow

Examples

string spos
spos =dw1.Object.DataWindow.HorizontalScrollPosition2
dw1.Object.DataWindow.HorizontalScrollPosition2 = 200
spos = dw1.Describe( &
   "DataWindow.HorizontalScrollPosition2")
dw1.Modify( &
   "DataWindow.HorizontalScrollPosition2=200")

HorizontalScrollSplit

Description

The position of the split in the DataWindow's horizontal scroll bar. If HorizontalScrollSplit is zero, the scroll bar is not split.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HorizontalScrollSplit

Describe and Modify argument:

"DataWindow.HorizontalScrollSplit { = splitdistance }"

Parameter	Description
splitdistance	An integer indicating where the split will occur in the horizontal scroll bar in a DataWindow object in the unit of measure specified for the DataWindow object

Examples

string setting
setting = dw1.Object.DataWindow.HorizontalScrollSplit
dw1.Object.DataWindow.HorizontalScrollSplit = 250
str = dw1.Describe("DataWindow.HorizontalScrollSplit")
dw1.Modify("DataWindow.HorizontalScrollSplit=250")

HTextAlign

Description

The way text in a button is horizontally aligned.

Applies to

Button controls

Syntax

PowerBuilder dot notation:

dw_control.Object.buttonname.HTextAlign

Describe and Modify argument:

"buttonname.HTextAlign { = ' value ' }"

Parameter

Description

buttonname

The name of the button for which you want to align text.

value

An integer indicating how the button text is horizontally aligned.

Values are:

0 -- Center

1 -- Left

2 -- Right

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Horizontal Alignment option.

Examples

dw1.Object.b_name.HTextAlign = "1"
setting = dw1.Describe("b_name.HTextAlign")
dw1.Modify("b_name.HTextAlign ='1'")

HTML.property (obsolete)

Description

Settings for adding user-defined HTML syntax and hyperlinks to controls in a Web DataWindow.

Obsolete property

HTML.property is obsolete and should not be used, because the Web DataWindow technology is obsolete.

Applies to

Column, Computed Field, Picture, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.HTML.property

Describe and Modify argument:

"controlname.HTML.property { = ' value ' }"

Parameter	Description
controlname	The name of the control whose HTML properties you want to get or set.
property	A property for generating HTML syntax and hyperlinks in a Web DataWindow. Properties and their values are listed in the table below.
value	The value to be assigned to the property. Value can be a quoted DataWindow expression only where noted.

Property for HTML	Value
AppendedHTML	HTML you want to append to the generated syntax for the rendering of a DataWindow control before the closing bracket of the HTML element for that control.
Link	(exp) A URL that is the target of a link (HTML anchor element) generated for each data item in the column or for the specified control. The text or user-visible part of the link will be the data value in the column, the value of the computed field, the text in the Text control, or the image of a Picture control. The URL can include parameters. Other properties, such as LinkArgs, can cause additional parameters to be added when the HTML is generated.
LinkArgs	A string in the form: argname='exp'{ \| argname = 'exp' } ... Argname is a page parameter to be passed to the server. Exp is a DataWindow expression whose value is a string. It is evaluated and converted using URL encoding and included in the linkargs string. The evaluated LinkArgs string is appended to the HTML.Link property when HTML is generated to produce a hyperlink for each data item in a column or other DataWindow control.
LinkTarget	(exp) The name of a target frame or window for the hyperlink (HTML A element) specified in the Link property. The target is included using the TARGET attribute. You can use the LinkTarget property to direct the new page to a detail window or frame in a master/detail page design. If LinkTarget is null or an empty string (""), then no TARGET attribute is generated.
ValueIsHTML (does not apply to Picture controls)	(exp) A boolean that, if true, allows the control contents (data value in a read-only column, the value of a computed field that is not calculated on the client, or the text in a Text control) to be generated as HTML. For XHTML, the control contents must be well-formed XHTML.

Usage

The Link properties are typically used to create master/detail Web pages where a link on a data item jumps to a detail DataWindow for that item. LinkArgs is used to pass a retrieval argument identifying the particular item.

The AppendedHTML property is used to specify attributes and event actions to add to the HTML rendered for Web DataWindow controls.

ScrollToRow emulation

The ValueIsHTML property allows you to include standalone HTML syntax or tags in the generated Web DataWindow. You can use this feature to add horizontal rules (<HR>) and anchor tags (<A HREF="home.htm">home</A>) to Web DataWindows. If you add row-specific anchor tags, you can use the Modify method or DataWindow expressions to generate conditional HTML for each row.

The HTML generator does not validate the HTML you append to or include in controls in DataWindow objects. If the HTML is invalid, the DataWindow might not display correctly. You must also be careful not to append an event name that is already generated for the control as a coded client-side event.

In the painter

Select the control and set the value in the Properties view, HTML tab.

Examples

// EMPID and PAGE are page parameters for the 
// page server's session object
dw1.Object.empid.HTML.Link = "empform.html"
dw1.Object.empid.HTML.LinkArgs = "EMPID = 'empid'"
dw1.Object.empid.HTML.LinkTarget = "detail_win"
dw1.Object.empid.HTML.ValueIsHTML = "true"
dw1.Object.helpicon.HTML.Link = "help.html"
dw1.Object.helpicon.LinkArgs = "PAGE = 'empform'"
setting = dw1.Describe("DataWindow.HTML.Link")
dw1.Modify("empid.HTML.Link = 'empform.html'")

HTMLDW (obsolete)

Description

Specifies whether HTML generated for the DataWindow object provides updates and interactivity.

Obsolete property

HTMLDW is obsolete and should not be used, because the Web DataWindow technology is obsolete.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HTMLDW = value

Describe and Modify argument:

"DataWindow.HTMLDW { = ' value ' }"

Parameter

Description

value

The value to be assigned to the property. Value can be a quoted DataWindow expression.

Values are:

Yes -- DataWindow HTML generation uses the HTMLGen properties.
No -- DataWindow HTML generation is a read-only. table as described for the Data.HTMLTable property.

Usage

When HTMLDW is set to Yes, the generated HTML supports data entry and takes advantage of browser features that enable user interaction when used with a page server (as described for the Data.HTML property). The generated HTML can be used to produce a page that displays a subset of retrieved rows and can include JavaScript code requesting additional pages with other subsets of the retrieved rows.

The resulting HTML can be used as a Web DataWindow control, which is a cooperation between a server component, a page server, and a client Web browser. The server component produces the HTML and the page server incorporates it into a Web page.

The user interacts with the DataWindow in the client browser, and actions produced by buttons in the DataWindow object are sent back to the page server. The page server calls methods of the server component to request processing for the data in the DataWindow object, including applying actions, updating data, and scrolling to other subsets.

To affect the level of DataWindow features in the resulting HTML, or to produce master/detail links between two Web DataWindow controls, see HTMLGen.property.

DataWindow features that will not be rendered into HTML include:

Graph, OLE, and RichText presentation styles and controls.
Client-side expressions that include aggregate functions. Aggregate functions cannot be evaluated in the browser. Instead, they will be evaluated on the server and the resulting value included in the HTML.
Resizable and movable controls.
Sliding of controls to fill empty space.
Autosizing of height or width.
EditMasks for column data entry.

In the painter

Select the DataWindow object by deselecting all controls; then select or clear the Web DataWindow check box on the General tab in the Properties view.

Examples

dw1.Object.DataWindow.HTMLDW = "yes"
setting = dw1.Describe ("DataWindow.HTMLDW")
dw1.Modify("DataWindow.HTMLDW = 'yes'")

HTMLGen.property (obsolete)

Description

Settings that control the level of features incorporated into HTML generated for the DataWindow.

Obsolete property

HTMLGen.property is obsolete and should not be used, because the Web DataWindow technology is obsolete.

The Web Generation tab and JavaScript Generation tab are preserved for the backward compatibility only.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HTMLGen.property

Describe and Modify argument:

"DataWindow.HTMLGen.property { = ' value ' }"

Parameter	Description
property	A property that controls how HTML is generated for a DataWindow. Properties and their values are listed in the table below.
value	The value to be assigned to the property. Value can be a quoted DataWindow expression where noted.

Property for HTMLGen	Value
Browser	(exp) A string identifying the browser in which you want to display the generated HTML. The value should match the browser identifier part of the text string that the browser specifies in the HTTP header it sends to the server. This property is usually set dynamically on the server according to the HTTP header returned from the client. Recognized strings are listed in Browser recognition.
ClientComputedFields	(exp) Whether computed fields that reference column data are translated into JavaScript and computed in the client browser. Values are: Yes -- (Default) Computed fields are translated to JavaScript where possible. No -- Computed fields are always calculated on the server. Regardless of this setting, if the computed field includes aggregation functions, the computed field is calculated on the server. For more information about this and the following properties, see Client properties
ClientEvents	(exp) Whether JavaScript code to trigger events is included in the generated HTML. Values are: Yes -- (Default) JavaScript for triggering events is generated. No -- JavaScript for events is not generated.
ClientFormatting	(exp) Whether display formats are applied to data items that do not have focus. JavaScript for formatting the data is translated from display formats specified in the DataWindow painter. If you want to use regional settings, such as a period as a date separator and a comma as a decimal separator, you must set ClientFormatting to Yes. Values are: Yes -- (Default) Display formats are applied to data. No -- Display formats are not used.
ClientScriptable	(exp) Whether client-side JavaScript can interact with the control. Values are: Yes -- Client-side JavaScript can call methods of the control. No -- (Default) Client-side JavaScript cannot call methods. This option adds approximately 20K to the size of the generated HTML.
ClientValidation	(exp) Whether JavaScript code to perform validation of user-entered data is included in the generated HTML. The validation code is translated from validation expressions specified in the DataWindow painter. Values are: Yes -- (Default) Validation expressions are generated. No -- Validation expressions are not generated.
CommonJSFile	(exp) Cache file name for common JavaScript functions required by Web DataWindows at runtime. If you set this property, the file is downloaded to the browser client once per session for use by all Web DataWindows. You can prefix the file name to a URL, or you can use the URL that you set with the HTMLGen.ResourceBase property. See JavaScript caching.
DateJSFile	(exp) Cache file name for common Web DataWindow functions that use a date format. If you set this property, the file is downloaded to the browser client once per session for use by all Web DataWindows. You can prefix the file name with a URL, or you can use the URL that you set with the HTMLGen.ResourceBase property. See JavaScript caching.
EncodeSelfLinkArgs	(exp) A switch to disable HTML 4 encoding of the evaluated HTMLGen.SelfLinkArgs expressions that are generated as hidden fields. The standard encoding limits character replacement to: ", &, <, and >. Disabling the standard encoding allows you to encode additional characters, but you must encode the argument expressions yourself. Values are: Yes -- (Default) Encoding performed by PowerBuilder. No -- Encoding not performed.
GenerateDDDWFrames	(exp) Specifies whether drop-down DataWindows are generated using inline frames (iFrames). The use of iFrames enhances the display so that the drop-down DataWindow displays in a Web application as it would in a Windows application. Using iFrames increases the volume of markup generated. Values are: Yes -- (Default) Drop-down DataWindows are generated in formatted div elements over an iFrame. No -- Drop-down DataWindows are generated in HTML select elements. The use of the GenerateDDDWFrames option for drop-down DataWindows is supported only in the Internet Explorer browser. In other browsers, the HTML select element is always used.
GenerateJavaScript	(exp) Specifies whether to generate JavaScript if the browser is not recognized. Keep in mind that without JavaScript, updating of data is not available. Navigation links are still supported. Values are: Yes -- (Default) JavaScript is generated even if the browser is not recognized. The resulting JavaScript is portable and does not use browser-specific features. No -- JavaScript is not generated unless the browser is recognized
HTMLVersion	(exp) The version of HTML to generate. Values are: 3.2 -- (Default) The HTML will include style sheets, but no absolute positioning or regular expressions. 4.0 -- The HTML will include style sheets, absolute positioning, and regular expressions. If the browser is recognized, this property is ignored and browser-specific HTML is generated.
NetscapeLayers	(exp) Formats the Web DataWindow for Netscape 4.0 or later using absolute positioning (in a manner similar to the formatting for Internet Explorer). See NetscapeLayers property.
NumberJSFile	(exp) Cache file name for common Web DataWindow functions that use a number format. If you set this property, the file is downloaded to the browser client once per session for use by all Web DataWindows. You can prefix the file name with a URL, or you can use the URL that you set with the HTMLGen.ResourceBase property. See JavaScript caching.
ObjectName	(exp) A string specifying a name used in generated code for the Web DataWindow client control, page parameters, and client-side events. You must specify a unique object name when there will be more than one Web DataWindow on a Web page so that names will not conflict.
PageSize	(exp) The number of rows of data to include in a generated Web page. If the Web page does not include all available rows, you can include button controls to navigate to the rest of the data. To include all available rows in the page, specify 0 for PageSize. If the HTMLDW property is set to Yes, PageSize is used. If it is set to No, PageSize is ignored and all rows in the result set are generated in a single page.
PagingMethod	A value of the WebPagingMethod enumerated variable that determines how paging is handled. Values are: PostBack! (0) -- (default) The control posts back to the server to perform paging operations. Callback! (1) -- The control calls a service on the client to perform paging operations. XMLClientSide! (2) -- The control retrieves the entire XML result set and performs paging operations on the client. This option is only available when the XML rendering format is used. See PagingMethod.
ResourceBase	(exp) The URL for included JavaScript files. If you set this property, you do not need to include a URL in the values for these other HTMLGen properties: CommonJSFile, DateJSFile, NumberJSFile, and StringJSFile.
SelfLink	(exp) A string specifying the URL for the current page. It cannot include parameters. Parameters specified in SelfLinkArgs can be added when HTML is generated. SelfLink is used to generate URLs for navigation buttons that obtain additional rows from the result set and for other buttons that reload the page, such as Update and Retrieve.
SelfLinkArgs	A string in the form: argname='exp'{ \| argname = 'exp' } ... Argname is a page parameter to be passed to the server. Exp is a DataWindow expression whose value is a string. The DataWindow in the server component evaluates it, converts it using URL encoding, and includes it in the SelfLinkArgs string. The evaluated SelfLinkArgs expressions are included in the generated HTML as hidden fields. The arguments supply information that the server needs to render additional pages of the result set, such as retrieval arguments.
StringJSFile	(exp) Cache file name for common Web DataWindow functions that use a string format. If you set this property, the file is downloaded to the browser client once per session for use by all Web DataWindows. You can prefix the file name with a URL, or you can use the URL that you set with the HTMLGen.ResourceBase property. See JavaScript caching.
TabIndexBase	(exp) Sets the starting tab order number for a Web DataWindow. This property is useful for a Web page with multiple Web DataWindows when you can tab between columns of the DataWindows. Setting this property has no effect on page functionality when the page is viewed in a browser that does not support the tab index attribute. The maximum tab index allowed for a page is 32767. See TabIndexBase property.
UserJSFile	(exp) Cache file name for user-defined Web DataWindow functions. If you set this property, the file is downloaded to the browser client once per session for use by all Web DataWindows. You can prefix the file name to a URL, or you can use the URL that you set with the HTMLGen.ResourceBase property. See JavaScript caching.

Usage

Most of these properties are considered only when the HTMLDW property is set to Yes.

Browser recognition

The Browser and HTMLVersion properties are always considered when HTML is generated, regardless of the HTMLDW setting.

Browser identification strings are sent by the client to the server in the HTTP header. The server component can assign the HTTP_USER_AGENT value from the HTTP header to the Browser property. If the string specifies a browser that the DataWindow engine supports, the DataWindow will generate HTML optimized for that browser. Browser-specific HTML is generated only for Microsoft Internet Explorer and Netscape browsers.

If the browser is not recognized or not specified, then the generated HTML will use the HTMLVersion and GenerateJavaScript properties to decide what features to include. DataWindow HTML generation recognizes these browsers:

Browser	HTTP header string	HTML features used
Netscape	Mozilla/1.x (	No style sheets, no absolute positioning, no JavaScript.
	Mozilla/2.x ( Mozilla/3.x (	JavaScript. No style sheets, no absolute positioning, no regular expressions.
	Mozilla/4.x (	Style sheets, JavaScript, regular expressions. No absolute positioning.
Microsoft Internet Explorer	Mozilla/1.22 (compatible; MSIE 2.x;	No style sheets, no absolute positioning, no tab order, no JavaScript.
	Mozilla/2.0 (compatible; MSIE 3.x;	Style sheets, tab order, JavaScript. No absolute positioning, no regular expressions.
	Mozilla/4.0 (compatible; MSIE 4.x, Mozilla/4.0 (compatible; MSIE 5.x; Mozilla/4.0 (compatible; MSIE 6.x;	Style sheets, absolute positioning, tab order, regular expressions.
Opera	Mozilla/3.0 (compatible; Opera 3.x;	JavaScript, regular expressions. No style sheets, no absolute positioning.

Columns with RichText edit style

To save rich text formatting in columns with the RichText edit style, the HTMLGen.Browser property must be set to "Microsoft Internet Explorer" and the HTMLGen.HTMLVersion property to "4.0".

Client properties

The ClientEvents, ClientFormatting, ClientValidation, ClientComputedFields, and ClientScriptable properties control the amount of JavaScript that is generated for the Web DataWindow, which impacts the size of the page that is downloaded to the browser. You can reduce the size of the generated HTML by setting one or more of the properties to No.

JavaScript caching

You can also reduce the size of the generated HTML by setting up cache files for common Web DataWindow client-side methods. You can generate these files using the JavaScript Generation wizard that you launch from a button on the JavaScript Generation tab of the Properties view in the DataWindow painter.

Once you generate these files, you can set the file names as values for the CommonJSFile, DateJSFile, NumberJSFile, and/or StringJSFile properties. When you set these properties, the methods defined in the referenced files will not be generated with the HTML in any Web DataWindow pages that are sent to the page server and client browser.

With JavaScript caching, you improve performance after the first Web DataWindow page is generated-as long as the browser on the client computer is configured to use cached files. With caching enabled, the browser loads the JS files from the Web server into its cache, and these become available for all the Web DataWindow pages in your application. There is no performance gain if the browser does not find the JS files in its cache since, in this case, it reloads the files from the Web server.

PagingMethod

The PagingMethod property determines whether the control uses the client-side script callback mechanism introduced in the .NET Framework 2.0 to execute server-side code without posting and refreshing the current page.

The default is to post back to the server (PostBack!).

The Callback! option uses script callbacks to retrieve the next page of XML data. It corresponds to the Microsoft GridView control's EnableSortingAndPagingCallback property, but applies only to paging. Client-side sorting is handled by another mechanism.

For the XML rendering format, the design of the Callback! option requires that a reusable XSLT stylesheet be generated so that the browser can cache it. The benefit from this requirement is that only the XML data for the next requested page need be returned by the callback. This XML data is always trivial in size (about a 1 to 20 ratio), resulting in significant bandwidth savings. This is unlike other implementations, where the entire presentation is always regenerated and downloaded again from every callback.

The generated XSLT stylesheet is not reusable, and therefore cannot be cached by the browser, if the DataWindow layout is inconsistent page-to-page, or it does not contain a complete first page of data. In these scenarios, the Callback! option defers to PostBack! until a stylesheet can be generated that is reusable, and can therefore be cached in the browser.

The XMLClientSide! option is only available with the XML rendering format. It retrieves the entire XML result set and uses XSLT re-transformation of the cached stylesheet to perform paging on the client. This option can currently be used only if the presentation style is uniform from page to page. For example, it cannot handle a summary band on the last page.

When PagingMethod is set to XMLClientSide!, InsertRow, AppendRow, and DeleteRow actions do not require a postback or callback to the server. However, computed fields in the DataWindow that are dependent on the RowCount method are not refreshed until an action such as Update or Retrieve forces a postback to the server.

NetscapeLayers property

Even if you set the NetscapeLayers property to true, certain functionality in a Netscape browser using absolute positioning might not be identical to the functionality available with Internet Explorer. For example, you cannot tab between DataWindow columns using a Netscape browser on an NT machine (although you can do this using a Netscape browser on a Solaris machine).

TabIndexBase property

If you add Web DataWindows to a page that already has a Web DataWindow on it, you can set the TabIndexBase property for each Web DataWindow you add.

For a page with two Web DataWindows, setting the tab index base for the second DataWindow to a number greater than the tab index for the last column of the first DataWindow allows the user (using an Internet Explorer browser) to tab through all the columns of the first DataWindow before tabbing to the second DataWindow. Otherwise, pressing the Tab key could cause the cursor and focus to jump from one DataWindow to another instead of tabbing to the next column in the DataWindow that initially had focus.

In the painter

Select the DataWindow object by deselecting all controls; then set the values in the Properties view, Web Generation tab or JavaScript Generation tab. Select HTML/XHTML from the Format to Configure list to display the properties.

Examples

dw1.Object.DataWindow.HTMLGen.HTMLVersion = "4.0"
setting = dw1.Describe ("DataWindow.HTMLGen.Browser")
dw1.Modify("DataWindow.HTMLGen.ClientValidation = 'no'")
dw1.Modify("DataWindow.HTMLGen.PublishPath = 'C:\Inetpub\wwwroot\MyWebApp\generatedfiles'")
dw1.Modify("DataWindow.HTMLGen.ResourceBase = '/MyWebApp/generatedfiles'")

This statement sets the XMLGen.Paging property so that the complete result set is downloaded to the client and paging takes place on the client:

dw1.Modify("DataWindow.HTMLGen.PagingMethod=XMLClientSide!")

This statement sets the HTMLGen.PagingMethod property to use script callbacks:

dw1.Object.DataWindow.HTMLGen.PagingMethod=1

HTMLTable.property (obsolete)

Description

Settings for the display of DataWindow data when displayed in HTML table format. These settings simplify the transfer of data from a database to an HTML page. They are particularly useful when used to create HTML pages dynamically.

Obsolete property

HTMLTable.property is obsolete and should not be used, because the Web DataWindow technology is obsolete.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.HTMLTable.property

Describe and Modify argument:

"DataWindow.HTMLTable.property { = ' value ' }"

Parameter	Description
property	A property for a DataWindow to be displayed in HTML table format. Properties and their values are listed in the table below.
value	The value to be assigned to the property. Value can be a quoted DataWindow expression.

Property for HTMLTable	Value
Border	(exp) Border attribute for the HTMLTable element. The default is 1 (line around the table).
CellPadding	(exp) CellPadding attribute for the HTMLTable element. The default is 0.
CellSpacing	(exp) CellSpacing attribute for the HTMLTable element. The default is 0.
GenerateCSS	(exp) Controls whether the DataWindow HTMLTable property's Table element contains border, cellpadding, cellspacing, nowrap, and width attributes. Also controls whether elements within the table contain CLASS references that control style sheet use. The default is no.
NoWrap	(exp) NoWrap attribute for the HTMLTable element. The default is to include this attribute.
StyleSheet	(exp) HTML cascading style sheet generated for the DataWindow.
Width	Width attribute for the HTMLTable element. The default is 0.

Usage

In the painter

Set the value using the Properties view, HTML Table tab.

Examples

dw1.Object.DataWindow.HTMLTable.Border = "2"
setting = dw1.Describe ("DataWindow.HTMLTable.StyleSheet")
dw1.Modify("DataWindow.HTMLTable.NoWrap = 'yes'")

ID

Description

The number of the column or TableBlob.

Applies to

Column and TableBlob controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.ID

Describe and Modify argument:

"controlname.ID"

Parameter	Description
controlname	The name of the column or TableBlob for which you want the ID number

Examples

setting = dw1.Object.empname.ID
setting = dw1.Describe("empname.ID")

Identity

Description

Whether the database is to supply the value of the column in a newly inserted row. If so, the column is not updatable; the column is excluded from the INSERT statement.

Not all DBMSs support the identity property. For more information see the documentation for your DBMS.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.Identity

Describe and Modify argument:

"columnname.Identity { = ' value ' }"

Parameter

Description

columnname

A string containing the name of the column for which you want to get or set the identity property.

value

A string indicating whether a column's value in a newly inserted row is supplied by the DBMS:

Yes -- The DBMS will supply the value of the column in a newly inserted row; the column is not updatable.

No -- The column is updatable.

Examples

dw1.Object.empid.Identity = "yes"
dw1.Modify("empid.Identity='yes'")

Import.XML.Trace

Description

Setting that determines whether import trace information is written to a log file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Import.XML.Trace

Describe and Modify argument:

"DataWindow.Import.XML.Trace { = ' value ' }"

Parameter

Description

value

Whether trace information is written to a log file.

Values are:

Yes -- Trace information is written to a log file.
No -- Trace information is not written to a log file (default).

Usage

If you want to collect trace information, this property should be set before you call the ImportClipboard, ImportFile, or ImportString method to import data from an XML document. The trace information is appended to the file you specify using the Import.XML.TraceFile property. If no trace file is specified, trace information is appended to a file named pbxmltrc.log in the current directory.

In the painter

In the Data Import tab in the Properties view for the DataWindow object, select XML from the Format to Configure list, and type a file name in the Trace File Name text box.

Examples

This example specifies that trace information should be written to a file called xmltrace.log in the C:\temp directory.

dw1.Modify("DataWindow.Import.XML.Trace = 'yes' ")
dw1.Modify("DataWindow.Import.XML.TraceFile = 'C:\temp\xmltrace.log' ")

See also

Import.XML.TraceFile

Description

Specifies the name and location of an import trace file.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Import.XML.TraceFile

Describe and Modify argument:

"DataWindow.Import.XML.TraceFile { = ' value ' }"

Parameter	Description
value	A string whose value is the name of the trace output file. If the file does not exist, it is created.

Usage

If you want to collect trace information, the Import.XML.Trace property should be set before you call the ImportClipboard, ImportFile, or ImportString method to import data from an XML document. The trace information is appended to the file you specify using the Import.XML.TraceFile property. If no trace file is specified, trace information is appended to a file named pbxmltrc.log in the current directory.

In the painter

In the Data Import tab in the Properties view for the DataWindow object, select XML from the Format to Configure list, and type a file name in the Trace File Name text box.

Examples

This example specifies that trace information should be written to a file called xmltrace.log in the C:\temp directory.

dw1.Object.DataWindow.Import.XML.Trace = 'yes'
dw1.Object.DataWindow.Import.XML.TraceFile = 'C:\temp\xmltrace.log'

See also

Import.XML.Trace

Import.XML.UseTemplate

Description

Setting that optionally controls the logical structure of the XML imported from an XML file into a DataWindow object using the ImportFile method.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Import.XML.UseTemplate

Describe and Modify argument:

"DataWindow.Import.XML.UseTemplate { = ' value ' }"

Parameter	Description
value	(exp) A string specifying the name of an import template previously saved in the DataWindow painter for the specified DataWindow object

Usage

This property should be set to specify the logical structure of the XML imported before you call the ImportFile method to import data from an XML document. An import template is not required if the XML document from which data is imported corresponds to the DataWindow column definition.

If an export template for a DataWindow object exists, it can be used as an import template. Only the mapping of column names to element attribute names is used for import. The order of elements within the template is not significant, because import values are located by name match and nesting depth within the XML document. All other information in the template, such as controls and comments, is ignored.

In the painter

In the Data Import tab in the Properties view for the DataWindow object, select XML from the Format to Configure list and select a template from the Use Template list.

Examples

This example sets the name of the current XML import template used in dw1 to t_import_report. If t_import_report does not exist, the current template is not changed.

dw1.Modify("DataWindow.Import.XML.UseTemplate = 't_import_report' ")

See also

Import.XML.UseTemplate

Initial

Description

The initial value of the column in a newly inserted row.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.Initial

Describe and Modify argument:

"columnname.Initial { = ' initialvalue ' }"

Parameter

Description

columnname

A string containing the name of the column for which you want to get or set the initial property.

initialvalue

A string containing the initial value of the column. Special values include:

Empty -- A string of length 0

Null -- No value

Spaces -- All blanks

Today -- Current date, time, or date and time

Examples

setting = dw1.Object.empname.Initial
dw1.Object.empname.Initial = "empty"
setting = dw1.Describe("empname.Initial")
dw1.Modify("empname.Initial='empty'")
dw1.Modify("empstatus.Initial='A'")

Ink.property

Description

Properties that control the attributes of ink in an InkPicture control or a column with the InkEdit edit style.

Applies to

Column and InkPicture controls

Syntax

PowerBuilder dot notation:

dw_control.Object.inkpicname.Ink.property
dw_control.Object.columnname.Ink.property

Describe and Modify argument:

"inkpicname.Ink.property { = value }"
"columnname.Ink.property { = value }"

Parameter	Description
inkpicname	The name of an InkPicture control.
columnname	The name of a column that has the InkEdit edit style.
property	A property for the InkPicture control or InkEdit column. Properties and their settings are listed in the table below.
value	The value to be assigned to the property.

Property for Ink	Value
AntiAliased	A drawing attribute that specifies whether the foreground and background colors along the edge of the drawn ink are blended (antialiased) to make the stroke smoother and sharper. Values are: true -- The ink stroke appears smoother and sharper (default) false -- The ink stroke is not antialiased Painter: InkAntiAliased option.
Color	A drawing attribute that specifies the current ink color. The default color is black. Painter: InkColor option.
Height	A drawing attribute that specifies the height of the side of the rectangular pen tip in HIMETRIC units (1 HIMETRIC unit = .01mm). The default is 1. Painter: InkHeight option.
IgnorePressure	A drawing attribute that specifies whether the drawn ink gets wider as the pressure of the pen tip on the tablet surface increases. Values are: true -- Pressure from the pen tip is ignored false -- The width of the ink increases with the pressure of the pen tip (default) Painter: IgnorePressure option.
Pentip	A drawing attribute that specifies whether the pen tip is round or rectangular. Values are: Ball (0) -- The pen tip is round (default) Rectangle (1) -- The pen tip is rectangular Painter: PenTip option.
Transparency	A drawing attribute that specifies the transparency of drawn ink. The range of values is from 0 for totally opaque (the default) to 255 for totally transparent. Painter: InkTransparency option.
Width	A drawing attribute that specifies the width of the side of the rectangular pen tip in HIMETRIC units (1 HIMETRIC unit = .01mm). The default is 53. Painter: InkWidth option.

Usage

In the painter

Select the control and set values in the Properties view, Ink or InkPicture tab, InkAttributes section.

Examples

dw1.Object.inkpic1.Ink.Antialiased = true
li_color = dw1.Describe("emp_status.Ink.Color")

See also

InkEdit.property

InkPic.property

InkEdit.property

Description

Properties that control the behavior of a column with the InkEdit edit style.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.InkEdit.property

Describe and Modify argument:

"columnname.InkEdit.property { = value }"

Parameter	Description
columnname	The name of a column that has the InkEdit edit style.
property	A property for the InkEdit column. Properties and their settings are listed in the table below.
value	The value to be assigned to the property.

Property for InkEdit	Value
AutoSelect	Whether to select the contents of the edit control automatically when it receives focus. Values are: Yes -- Select automatically (default). No -- Do not select automatically. You can use AutoSelect with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Selection option.
DisplayOnly	Specifies whether the text is display-only and cannot be changed by the user. Values are: true -- Text cannot be changed by user. false -- Text can be changed by user (default). Painter: Display Only option.
Factoid	Specifies a context for ink recognition. Set this property if the input data is of a known type, such as a date or Web address, to constrain the search for a recognition result. Possible values include digit, e-mail, Web, date, time, number, currency, percent, and telephone. For a list of values, see the table that follows. Painter: Factoid option.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) will surround the current row of the column when the column has focus. Values are: Yes -- (Default) Display the focus rectangle. No -- Do not display the focus rectangle (default). You can use FocusRectangle with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Show Focus Rectangle option.
HScrollbar	Whether a horizontal scroll bar displays in the edit control. Values are: Yes -- Display the horizontal scroll bar. No -- Do not display the horizontal scroll bar (default). Painter: Horizontal Scroll Bar option.
InkMode	Specifies whether ink collection is enabled and whether ink only or ink and gestures are collected. Values are: InkDisabled (0) -- Ink collection is disabled. CollectInkOnly (1) -- Only ink is collected. CollectInkAndGestures (2) -- Ink and gestures are collected (default). Painter: InkMode option.
Limit	A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited. Painter: Limit option.
NilIsNull	Whether to set the data value of the InkEdit to null when the user leaves the edit box blank. Values are: Yes -- Make the Empty string null. No -- Do not make the empty string null (default). Painter: Empty String is null option.
RecognitionTimer	Specifies the time period in milliseconds between the last ink stroke and the start of text recognition. The default is 2000 (two seconds). Painter: RecognitionTimer option.
Required	Whether the column is required. Values are: Yes -- Required. No -- (Default) Not required. Painter: Required option.
UseMouseForInput	Specifies whether the mouse can be used for input on a Tablet PC. Values are: true -- The mouse can be used for input false -- The mouse cannot be used for input (default) Painter: UseMouseForInput option.
VScrollbar	Whether a vertical scroll bar displays in the edit control. Values are: Yes -- Display a vertical scroll bar. No -- Do not display a vertical scroll bar (default). Painter: Vertical Scroll Bar option.

Usage

The following values for Factoid are available. After the Default and None factoids, the drop-down list in the Properties view displays factoids for special formats in alphabetical order, followed by single-character factoids and Asian-language factoids. You can set multiple factoids by separating them with the pipe ( | ) character.

Factoid	Description
Default	Returns recognizer to the default setting. For Western languages, the default setting includes the user and system dictionaries, various punctuation marks, and the Web and Number factoids. For Eastern languages, the default setting includes all characters supported by the recognizer.
None	Disables all factoids, dictionaries, and the language model.
Currency	Currency in pounds, dollars, euros, and yen.
Date	Dates written in English; for example 8/19/2005, Aug 19, 2005, or Friday, August 19, 2005.
E-mail	E-mail addresses.
Filename	Windows file name paths. The name cannot include the following characters: / : " < > \|
Number	Numeric values, including ordinals, decimals, separators, common suffixes, and mathematical symbols. This factoid includes the Currency and Time factoids.
Percent	A number followed by the percent symbol.
Postal Code	Postal codes as written in English, for example 01730 or CT17 9PW.
System Dictionary	Words in the system dictionary only.
Telephone	Telephone numbers as written in English, for example (555) 555 5555 or +44 1234 123456.
Time	Times as written in English, for example 15:05 or 3:05 pm.
Web	Various URL formats.
Word List	Words on the word list associated with the recognizer context only.
Digit	A single digit (0-9).
One Char	A single ANSI character.
Upper Char	A single uppercase character.

In addition, the following Asian-language factoids are available:

Bopomofo	Kanji Common
Hangul Common	Katakana
Hiragana	Korean Common
Jamo	Simplified Chinese Common
Japanese Common	Traditional Chinese Common

In the painter

Select the control and set values in the Properties view, Ink tab for properties relating to Ink, or the Edit tab for properties common to other edit styles. The Style Type on the Edit tab must be set to InkEdit.

Examples

string str
str = dw1.Object.emp_name.InkEdit.Factoid
dw1.Object.emp_name.InkEdit.Factoid = EMAIL
str = dw1.Describe("emp_bd.InkEdit.Factoid")
dw1.Modify("emp_bd.InkEdit.Factoid=EMAIL")
string str
str = dw1.Object.emp_name.InkEdit.AutoHScroll
dw1.Object.emp_name.InkEdit.Required = "no"

See also

Ink.property

InkPic.property

Description

Properties that control the behavior of ink in an InkPicture control.

Applies to

InkPicture controls

Syntax

PowerBuilder dot notation:

dw_control.Object.inkpicname.InkPic.property

Describe and Modify argument:

"inkpicname.InkPic.property { = value }"

Parameter	Description
inkpicname	The name of an InkPicture control.
property	A property for the InkPicture control. Properties and their settings are listed in the table below.
value	The value to be assigned to the property.

Property for InkPic	Value
AutoErase	Specifies whether the auto erase feature available on some styluses is turned on. Values are: true -- AutoErase is turned on. false -- AutoErase is turned off (default). Painter: AutoErase option.
BackColor	Specifies the numeric value of the background color: -2 to 16,777,215. For more information about color, see the RGB function. Painter: BackColor option.
CollectionMode	Specifies whether ink only, gestures only, or ink and gestures are collected. Values are: InkOnly (0) -- Only ink is collected (default). GestureOnly (1) -- Only gestures are collected. InkAndGesture (2) -- Ink and gestures are collected. Painter: CollectionMode option.
DynamicRendering	Specifies whether the ink is rendered (displayed in the control) as it is drawn. The default is true. Painter: DynamicRendering option.
EditMode	Specifies whether the editing mode of the control is set for drawing, deleting, or selecting ink. Values are: InkMode (0) -- Ink is drawn (default). DeleteMode (1) -- Ink is deleted. SelectMode (2) -- Ink is selected. Painter: EditMode option.
EraserMode	Specifies whether ink is removed by stroke or point. Values are: StrokeErase (0) -- The entire ink stroke under the stylus is removed (default). PointErase (1) -- Only the ink under the stylus is removed. Painter: EraserMode option.
EraserWidth	Specifies the width of the eraser pen tip in HIMETRIC units (1 HIMETRIC unit = .01mm). The default is 212. This property applies when EditMode is set to DeleteMode and EraserMode is set to PointErase. Painter: EraserWidth option.
HighContrastInk	Specifies whether ink is rendered in a single color when the system is in high contrast mode and draws the selection rectangle and handles in high contrast. Values are: true -- Ink is rendered in a single color in high contrast mode (default). false -- Ink is not rendered in a single color in high contrast mode. Painter: HighContrastInk option.
InkEnabled	Specifies whether the InkPicture control collects pen input. Values are: true -- The control collects pen input (default). false -- The control does not collect pen input and no pen-related events fire. Painter: InkEnabled option.
MarginX	Specifies the x-axis margin around the control in PowerBuilder units. The default value is 0. Painter: MarginX option.
MarginY	Specifies the y-axis margin around the control in PowerBuilder units. The default value is 0. Painter: MarginY option.
PictureSizeMode	Specifies how the picture is displayed in the control. Values are: Center Image (1) -- The picture is centered in the control. Normal (2) -- The picture is displayed in the upper-left corner of the control and any part of the picture that does not fit in the control is clipped (default). Stretch (3) -- The picture is stretched to fill the control. Painter: PictureSizeMode option.

Usage

In the painter

Select the control and set values in the Properties view, InkPicture tab.

Examples

dw1.Object.inkpic1.InkPic.InkEnabled = true
li_color = dw1.Describe("inkpic1.InkPic.BackColor")

See also

Ink.property

Invert

Description

The way the colors in a Picture control are displayed, either inverted or normal.

Applies to

Picture controls

Syntax

PowerBuilder dot notation:

dw_control.Object.bitmapname.Invert

Describe and Modify argument:

"bitmapname.Invert { = ' number ' }"

Parameter

Description

bitmapname

The name of the Picture control in the DataWindow for which you want to invert the colors.

number

(exp) A boolean number indicating whether the colors of the picture will display inverted. Values are:

0 -- (Default) No; do not invert the picture's colors.

1 -- Yes; display the picture with colors inverted.

Number can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Invert Image check box.

Examples

string setting
setting = dw1.Object.bitmap_1.Invert
dw1.Object.bitmap_1.Invert="0~tIf(empstatus='A',0,1)"
setting = dw1.Describe("bitmap_1.Invert")
dw1.Modify(  &
"bitmap_1.Invert='0~tIf(empstatus=~~~'A~~~',0,1)'")

JSGen.property (obsolete)

Description

Settings that specify the physical path to which generated JavaScript is published and the URL indicating the location of the generated JavaScript.

Obsolete property

JSGen.property is obsolete and should not be used, because the Web DataWindow technology is obsolete.

The Web Generation tab and JavaScript Generation tab are preserved for the backward compatibility only.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.JSGen.property

Describe and Modify argument:

"DataWindow.JSGen.property { = ' value ' }"

Parameter

Description

property

One of the following:

PublishPath
ResourceBase

value

(exp) PublishPath -- A string that specifies the physical path of the Web site folder to which PowerBuilder publishes the generated JavaScript.

(exp) ResourceBase -- A string that specifies the URL of the generated JavaScript for performing client-side XSLT transformation and instantiation of client-side data.

Usage

The PublishPath folder must correspond to the URL specified in the ResourceBase property. At runtime, after PowerBuilder generates JavaScript to the PublishPath folder, it includes it in the final XHTML page by referencing it with the value of the ResourceBase property in a <script> element.

In the painter

In the JavaScript Generation tab in the Properties view for the DataWindow object, select XHTML from the Format to Configure list and specify the ResourceBase and Publish Path locations.

Examples

These statements set the JSGen.ResourceBase and JSGen.PublishPath properties:

dw1.Object.DataWindow.JSGen.ResourceBase= &
   'http://www.myserver.com/xmlsource'
dw1.Object.DataWindow.JSGen.PublishPath= &
   'C:\work\outputfiles\xmlsource'

Key

Description

Whether the column is part of the database table's primary key.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.Key

Describe and Modify argument:

"columnname.Key { = value }"

Parameter

Description

columnname

The column for which you want to get or set primary key status.

value

Whether the column is part of the primary key. Values are:

Yes -- The column is part of the primary key

No -- The column is not part of the key

Usage

In the painter

Set the value using the Rows menu, Update Properties.

Examples

string setting
setting = dw1.Object.empid.Key
dw1.Object.empid.Key = "Yes"
setting = dw1.Describe("empid.Key")
dw1.Modify("empid.Key=Yes")

KeyClause

Description

An expression to be used as the key clause when retrieving the blob.

Applies to

TableBlob controls

Syntax

PowerBuilder dot notation:

dw_control.Object.tblobname.KeyClause

Describe and Modify argument:

"tblobname.KeyClause { = ' keyclause ' }"

Parameter	Description
tblobname	The name of the TableBlob for which you want to specify a key clause.
keyclause	(exp) A string that will be built into a key clause using the substitutions provided. The key clause can be any valid WHERE clause. Keyclause can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Definition tab, Key Clause option.

Examples

With the following setting, the value of key_col will be put in col2 when PowerBuilder constructs the WHERE clause for the SELECTBLOB statement:

dw1.Modify(blob_1.KeyClause='Key_col = :col2'")

Label.property

Description

Settings for a DataWindow whose presentation style is Label.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Label.property

Describe and Modify argument:

"DataWindow.Label.property { = value }"

SyntaxFromSql:

DataWindow(Label.property = value)

Parameter	Description
property	A property for the Label presentation style. Properties and their settings are listed in the table below.
value	The value to be assigned to the property. For Label properties, value cannot be a DataWindow expression.

Property for Label	Value
Columns	An integer indicating the number of columns of labels on a sheet. Painter: Label group, Labels Across option.
Columns.Spacing	An integer indicating the space between columns of labels in the units specified for the DataWindow object. Painter: Arrangement group, Between Columns option.
Ellipse_Height	An integer specifying the height of the rounded corners of a RoundRectangle label. This property is not valid for any other label shape. This value uses the same unit of measure specified for the DataWindow object. Painter: Not set in painter.
Ellipse_Width	An integer specifying the width of the rounded corners of a RoundRectangle label. This property is not valid for any other label shape. This value uses the same unit of measure specified for the DataWindow object. Painter: Not set in painter.
Height	An integer specifying the height of a label in the units specified for the DataWindow object. Painter: Label group, Height option.
Name	A string containing the name of a label. Painter: Predefined Label option.
Rows	An integer indicating the number of rows of labels on a sheet. Painter: Label group, Labels Down option.
Rows.Spacing	An integer indicating the space between rows of labels on a sheet in the units specified for the DataWindow object. Painter: Arrangement group, Between Rows option.
Shape	A string specifying the shape of a label. Values are: Rectangle RoundRectangle Oval Painter: Not set in painter.
Sheet	(Describe only) Whether the paper is sheet fed or continuous. Values are: Yes -- Sheet fed No -- Continuous Painter: Arrangement group, Paper option.
TopDown	(Describe only) Whether the labels will be printed from the top to the bottom or across the page. Values are: No -- Print labels across the page. Yes -- Print labels from top to bottom. Painter: Arrangement group, Arrange option.
Width	An integer specifying the width of a label in the units specified for the DataWindow object. Painter: Label group, Width option.

Usage

In the painter

Select the DataWindow object by deselecting all controls; then set the value in the Properties view, General tab (when presentation style is Label).

Examples

string setting
setting = dw1.Object.DataWindow.Label.Sheet
dw1.Object.DataWindow.Label.Width = 250
setting = dw1.Describe("DataWindow.Label.Sheet")
dw1.Modify("DataWindow.Label.Width=250")
dw1.Modify("DataWindow.Label.Height=150")
dw1.Modify("DataWindow.Label.Columns=2")
dw1.Modify("DataWindow.Label.Width=250")
dw1.Modify("DataWindow.Label.Name='Address1'")

LabelDispAttr.fontproperty

LastRowOnPage

Description

The last row currently visible in the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.LastRowOnPage

Describe argument:

"DataWindow.LastRowOnPage"

Examples

string setting
setting = dw1.Object.DataWindow.LastRowOnPage
setting = dw1.Describe("DataWindow.LastRowOnPage")

Left_Margin

Description

The size of the left margin of the DataWindow object.

Applies to

Style keywords

Syntax

SyntaxFromSql:

Style ( Left_Margin = value )

Parameter	Description
value	An integer specifying the size of the left margin in the units specified for the DataWindow

Examples

SQLCA.SyntaxFromSQL(sqlstring, &
'Style( ... LeftMargin = 500 ... )', errstring)

Legend

Description

The location of the legend in a Graph control in a DataWindow.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Legend

Describe and Modify argument:

"graphname.Legend { = ' value ' }"

Parameter

Description

graphname

The name of the graph control for which you want to specify the location of the legend.

value

(exp) A number indicating the location of the legend of a graph.

Values are:

0 -- None

1 -- Left

2 -- Right

3 -- Top

4 -- Bottom

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Legend option (applicable when the graph has more than one series).

Examples

string setting
setting = dw1.Object.graph_1.Legend
dw1.Object.graph_1.Legend = 2
setting = dw1.Describe("graph_1.Legend")
dw1.Modify("graph_1.Legend=2")
dw1.Modify("graph_1.Legend='2~tIf(dept_id=200,0,2)'")

Legend.DispAttr.fontproperty

Level

Description

The grouping level.

Level is used in DataWindow syntax only for the Create method.

Applies to

Group keywords

Syntax

Group ( BY( colnum1, colnum2, ... ) ... Level = n ... )

LineRemove

Description

(RichText presentation style only) Whether the line of text that contains the input field for the column or computed field is removed when the input field is empty. LineRemove is similar to the SlideUp property for controls in other presentation styles.

Applies to

Column and Computed Field controls in the RichText presentation style

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.LineRemove

Describe and Modify argument:

"controlname.LineRemove { = ' value ' }"

Parameter

Description

controlname

The name of the column or computed field whose line of text you want removed when the input field is empty.

value

(exp) Whether the line of text is removed so that the rest of the text slides up when the input field for controlname is empty. Values are:

Yes -- The line of text will be removed when the input field is empty.
No -- The line of text will not be removed.

Value can be a quoted DataWindow expression.

Examples

string setting
setting = dw1.Object.emp_street2.LineRemove
dw1.Object.emp_street2.LineRemove = true
setting = dw1.Describe("emp_street2.LineRemove")
dw1.Modify("emp_street2.LineRemove=yes")

LinkUpdateOptions

Description

When the OLE Object control is linked, the method for updating the link information. If the user tries to activate the OLE object and PowerBuilder cannot find the linked file, which breaks the link, LinkUpdateOptions controls whether PowerBuilder automatically displays a dialog box prompting the user to find the file. If you turn off the automatic dialog box, you can reestablish the link by calling the LinkTo or LinkUpdateDialog in code.

Applies to

OLE Object controls

Syntax

PowerBuilder dot notation:

dw_control.Object.olecontrolname.LinkUpdateOptions

Describe and Modify argument:

"olecontrolname.LinkUpdateOptions { = 'updatetype ' }"

Parameter

Description

olecontrolname

The name of the OLE Object control for which you want to get or set the link update method.

updatetype

A number specifying how broken links will be reestablished. Updatetype can be a quoted DataWindow expression.

Values are:

LinkUpdateAutomatic!
LinkUpdateManual!

Usage

In the painter

Select the control and set the value in the Properties view, Options tab, Link Update option.

Examples

string ls_data
ls_data = dw1.Object.ole_report.LinkUpdateOptions
dw1.Object.ole_report.LinkUpdateOptions = 0
ls_data = dw1.Describe("ole_report.LinkUpdateOptions")
dw1.Modify("ole_report.LinkUpdateOptions='0'")

Message.Title

Description

The title of the dialog box that displays when an error occurs.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Message.Title

Describe and Modify argument:

"DataWindow.Message.Title { = ' titlestring ' }"

SyntaxFromSql:

DataWindow(Message.Title = ' titlestring ' )

Parameter	Description
titlestring	A string containing the title for the title bar of the DataWindow dialog box that displays when an error occurs

Examples

setting = dw1.Object.DataWindow.Message.Title
dw1.Object.DataWindow.Message.Title = "Mistake!"
setting = dw1.Describe("DataWindow.Message.Title")
dw1.Modify("DataWindow.Message.Title='Bad, Bad, Bad'")
SQLCA.SyntaxFromSQL(sql_syntax, &
"Style(...) &
DataWindow(Message.Title='Sales Report' ...) ...", &
ls_Errors)

Moveable

Description

Whether the specified control in the DataWindow can be moved at runtime. Moveable controls should be in the DataWindow's foreground.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Line, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Moveable

Describe and Modify argument:

"controlname.Moveable { = number }"

Parameter

Description

controlname

The control within the DataWindow for which you want to get or set the Moveable property that governs whether the user can move the control

number

A boolean number specifying whether the control is movable.

Values are:

0 -- False, the control is not movable.

1 -- True, the control is movable.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab.

Examples

string setting
setting = dw1.Object.bitmap_1.Moveable
dw1.Object.bitmap_1.Moveable = 1
setting = dw1.Describe("bitmap_1.Moveable")
dw1.Modify("bitmap_1.Moveable=1")

Multiline

Description

(RichText presentation style) Whether the column or computed field can contain multiple lines. Multiline is effective only when Width.Autosize is set to No.

Applies to

Column and Computed Field controls in the RichText presentation style

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Multiline

Describe and Modify argument:

"controlname.Multiline { = ' value ' }"

Parameter

Description

controlname

The name of the column or computed field that will contain multiple lines.

value

(exp) Whether the input field can contain multiline lines. Values are:

Yes -- The input field can contain multiple lines.
No -- The input field cannot contain multiple lines.

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Input Field or Compute tab, MultiLine option.

To display the property sheet, click the input field (column or computed field) to select it. Then right-click and select Properties from the pop-up menu.

Examples

string setting
setting = dw1.Object.emp_street2.Multiline
dw1.Object.emp_street2.Multiline = true
setting = dw1.Describe("emp_street2.Multiline")
dw1.Modify("emp_street2.Multiline=yes")

Name

Description

The name of the control.

Applies to

Button, Column, Computed Field, Graph, GroupBox, InkPicture, Line, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Name

Describe argument:

"controlname.Name"

Parameter	Description
controlname	The control for which you want the name. For columns, you can specify the column number preceded by #.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Name option.

Examples

setting = dw1.Object.#4.Name
setting = dw1.Describe("#4.Name")

Nest_Arguments

Description

The values for the retrieval arguments of a nested report. The number of values in the list should match the number of retrieval arguments defined for the nested report.

Applies to

Report controls

Syntax

PowerBuilder dot notation:

dw_control.Object.reportname.Nest_Arguments

Describe and Modify argument:

"reportname.Nest_Arguments { = list } "

Parameter

Description

reportname

The name of the nested report for which you want to supply retrieval argument values.

list

A list of values for the retrieval arguments of the nested report. The format for the list is:

( ("arg1") {,("arg2") {,("arg3") {,... } } } )

Usage

The list is not a quoted string. It is surrounded by parentheses, and each argument value within the list is parenthesized, surrounded with double quotes, and separated by commas. If an argument is a literal string, use single quotes within the double quotes.

When changing the values for the retrieval arguments, you must supply values for all the retrieval arguments defined for the report. If you specify fewer or more arguments, an error will occur at runtime when the DataWindow retrieves its data.

To remove the report's retrieval arguments, specify empty parentheses. If no arguments are specified, the user is prompted for the values at runtime.

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

setting = dw1.Object.rpt_1.Nest_Arguments
dw1.Object.rpt_1.Nest_Arguments = &
"((~"cust_id~"),(~"'Eastern'~"))"
setting = dw1.Describe("rpt_1.Nest_Arguments")
dw1.Modify("rpt_1.Nest_Arguments" "=((~"cust_id~"), (~"'Eastern'~"))")
dw1.Modify("rpt_1.Nest_Arguments=()")

Nested

Description

Whether the DataWindow contains nested DataWindows. Values returned are Yes or No.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Nested

Describe argument:

"DataWindow.Nested"

Examples

string setting
setting = dw1.Object.DataWindow.Nested
setting = dw1.Describe("DataWindow.Nested")

NewPage (Group keywords)

Description

Whether a change in the value of a group column causes a page break.

Applies to

Group keywords

Syntax

SyntaxFromSql:

Group ( colnum1, colnum2 NewPage )

Examples

 SQLCA.SyntaxFromSQL(sql_syntax, &
"Style(Type=Group) " + &
"Group(#3 NewPage ResetPageCount)", &
ls_Errors)

NewPage (Report controls)

Description

Whether a nested report starts on a new page. NewPage applies only to reports in a composite DataWindow. Note that if the Trail_Footer property of the preceding report is set to No, the current report will be forced to begin on a new page regardless of the NewPage value.

Applies to

Report controls

Syntax

PowerBuilder dot notation:

dw_control.Object.reportname.NewPage

Describe and Modify argument:

"reportname.NewPage { = value } "

Parameter

Description

reportname

The name of the report control for which you want to get or set the NewPage property.

value

Whether the report begins a new page.

Values are:

Yes -- Start the report on a new page.

No -- Do not start the report on a new page.

Usage

In the painter

Select the Report control in the Composite presentation style and set the value in the Properties view, General tab, New Page check box.

Examples

string newpage_setting
newpage_setting = dw1.Object.rpt_1.NewPage
dw1.Object.rpt_1.NewPage = "Yes"
newpage_setting = dw1.Describe("rpt_1.NewPage")
dw1.Modify("rpt_1.NewPage=Yes")

NoUserPrompt

Description

Determines whether message boxes are displayed to the user during DataWindow processing.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.NoUserPrompt

Describe and Modify argument:

"DataWindow.NoUserPrompt { = ' value ' }"

Parameter

Description

value

A string specifying whether any message box requiring user intervention displays during DataWindow processing.

Values are:

Yes -- No message box displays.

No -- (Default) Message boxes display when invoked during DataWindow processing.

Usage

Set the NoUserPrompt property to yes if the DataWindow is to be used in a batch process when there is no possibility of end-user intervention. Dialog boxes you can prevent from displaying include the Error, Print, Retrieve, CrossTab, Expression, SaveAs, Import, Query, RichText, Filter, and Sort dialog boxes.

Examples

dw1.Object.DataWindow.NoUserPrompt = "yes"
dw1.Modify("DataWindow.NoUserPrompt=no")

Objects

Description

A list of the controls in the DataWindow object. The names are returned as a tab-separated list.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Objects

Describe argument:

"DataWindow.Objects"

Examples

setting = dw1.Describe("DataWindow.Objects")

OLE.Client.property

Description

Settings that some OLE server applications use to identify the client's information. The property values can be used to construct the title of the server window.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.OLE.Client.property

Describe and Modify argument:

"DataWindow.OLE.Client.property { = ' value ' }"

Parameter	Description
property	An OLE client property, as shown in the table below.
value	Values for the properties are shown in the table below. Value cannot be a DataWindow expression.

Property for OLE.Client	Value
Class	The client class for the DataWindow. The default is DataWindow.
Name	The client name for the DataWindow. The default is Untitled.

Usage

In the painter

Select the control and set the value in the Properties view, Definition tab.

Examples

ls_data = dw1.Object.DataWindow.OLE.Client.Class
dw1.Object.DataWindow.OLE.Client.Class = "PB"
ls_data = dw1.Describe("DataWindow.OLE.Client.Class")
dw1.Modify("DataWindow.OLE.Client.Class = 'PB'")

OLEClass

Description

The name of the OLE class for the TableBlob control.

Applies to

TableBlob controls

Syntax

PowerBuilder dot notation:

dw_control.Object.tblobname.OLEClass

Describe and Modify argument:

"tblobname.OLEClass { = 'oleclassname ' }"

Parameter	Description
tblobname	The TableBlob column for which you want to get or set the class of server application.
oleclassname	(exp) A string specifying a class of an OLE server application installed on your system. Oleclassname is quoted and can be a DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Definition tab, OLE Class: Description option.

Examples

setting = dw1.Object.blob_1.OLEClass
dw1.Object.blob_1.OLEClass = 'Word.Document'
setting = dw1.Describe("blob_1.OLEClass")
dw1.Modify("blob_1.OLEClass='Word.Document'")

OriginalSize

Description

The property specifies whether the width and height of the picture are set to their original values.

Applies to

Button and Bitmap controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.OriginalSize

Describe and Modify argument:

"controlname.OriginalSize { = 'value'} "

Parameter

Description

controlname

The control for which you want to set the value.

value

A string specifying whether the control's image is set to its original size.

Values are:

True -- The image displays at its original size.

False -- The image height and width can be set to other measurements.

Usage

In the painter

Select the control and then set the value in the Properties view, General tab, Original Size check box.

In scripts

The OriginalSize property takes a boolean value. The following line sets the OriginalSize property to false:

dw_1.Object.p_empphoto.originalsize="false"

You should not try to change the width or height of a picture control when OriginalSize is set to true, because it can lead to unexpected behavior.

Examples

dw_1.Modify("p_empphoto.originalsize='true'")
dw_1.Modify("p_product.originalsize='false'")
dw_1.Modify("p_product.height='250'")
dw_1.Modify("p_product.width='250'")

OverlapPercent

Description

The percentage of overlap for the data markers (such as bars or columns) in different series in a graph.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.OverlapPercent

Describe and Modify argument:

"graphname.OverlapPercent { = ' integer ' }"

Parameter	Description
graphname	The name of the graph control in the DataWindow object for which you want to get or set the percentage of overlap.
integer	(exp) An integer specifying the percent of the width of the data markers that will overlap. Integer can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, OverlapPercent option (applicable when a series has been specified).

Examples

string setting
setting = dw1.Object.graph_1.OverlapPercent
dw1.Object.graph_1.OverlapPercent = 25
setting = dw1.Describe("graph_1.OverlapPercent")
dw1.Modify("graph_1.OverlapPercent=25")

Pen.property

Description

Settings for a line or the outline of a control.

Applies to

Line, Oval, Rectangle, and RoundRectangle controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Pen.property

Describe and Modify argument:

"controlname.Pen.property { = value }"

Parameter	Description
controlname	The name of the control whose Pen property you want to get or set.
property	A property that applies to the Pen characteristics of controlname, as listed in the table below.
value	The value of the property, as shown in the table below. Value can be a quoted DataWindow expression.

Property for Pen

Value

Color

(exp) A long specifying the color (the red, green, and blue values) to be used as the control's line color.

Painter: Pen Color option.

Style

(exp) A number specifying the style of the line.

Values are:

0 -- Solid

1 -- Dash

2 -- Dotted

3 -- Dash-dot pattern

4 -- Dash-dot-dot pattern

5 -- Null (no visible line)

Painter: Pen Style option.

Width

(exp) A number specifying the width of the line in the unit of measure specified for the DataWindow.

Painter: Pen Width option (not available when Style is a value other than Solid).

Usage

In the painter

Select the control and set values in the Properties view, General tab.

Examples

string setting
setting = dw1.Object.line_1.Pen.Width
dw1.Object.line_1.Pen.Width = 10
setting = dw1.Describe("line_1.Pen.Width")
dw1.Modify("line_1.Pen.Width=10")

Perspective

Description

The distance from the front of the window at which the graph appears.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Perspective

Describe and Modify argument:

"graphname.Perspective { = ' integer ' }"

Parameter	Description
graphname	The name of the graph control in the DataWindow object for which you want to get or set the perspective.
integer	(exp) An integer between 1 and 100 specifying how far away the graph appears. The larger the number, the greater the distance and the smaller the graph appears. Integer can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Perspective scroll bar (available when a 3D graph type is selected).

Examples

string setting
setting = dw1.Object.graph_1.Perspective
dw1.Object.graph_1.Perspective = 20
setting = dw1.Describe("graph_1.Perspective")
dw1.Modify("graph_1.Perspective=20")

Picture.property

Description

Settings that control the background picture displayed in a DataWindow object. Picture properties are not supported in RichText, Graph, or OLE DataWindow presentation styles.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.datawindow.picture.property

Describe and Modify argument:

"DataWindow.picture.property { = value }"

Parameter	Description
property	A property for the picture background. Properties and their settings are listed in the table that follows. Picture properties are used only when the datawindow.brushmode value is 6. These properties are not available for RichText, Graph, or OLE DataWindow objects.
value	The value to be assigned to the property. For picture properties, value can be a quoted DataWindow expression.

Property for Picture	Value
Clip.Bottom	An integer specifying the percentage to clip from the bottom edge of the background picture. Painter: Background tab, Picture group.
Clip.Left	An integer specifying the percentage to clip from the left edge of the background picture. Painter: Background tab, Picture group.
Clip.Right	An integer specifying the percentage to clip from the right edge of the background picture. Painter: Background tab, Picture group.
Clip.Top	An integer specifying the percentage to clip from the top edge of the background picture. Painter: Background tab, Picture group.
File	Painter: Background tab, Picture group. A string indicating the pathname for the picture file to be used for the DataWindow background. Supported formats are BMP, GIF, JPEG, RLE, WMF, and PNG.
Mode	An integer indicating the orientation and size of the background picture, and whether it is tiled. Tiling also depends on the Scale.X and Scale.Y values. Values are: 0 -- Original Size 1 -- Fit to Width 2 -- Fit to Height 3 -- Preserve Aspect Ratio/Max to Rect 4 -- Stretch to Fit 5 -- Tile 6 -- Flip X 7 -- Flip Y 8 -- Flip XY Painter: Background tab, Picture group.
Scale.X	An integer from 0 to 100 that indicates the horizontal size of the bitmap in relation to the horizontal size of the DataWindow object. If you set the Scale.X and Scale.Y properties to 100, the background picture will cover the entire DataWindow object. This property is used only when picture.tilemode is set to 5, 6, 7, or 8. Painter: Background tab, Picture group.
Scale.Y	An integer from 0 to 100 that indicates the vertical size of the bitmap in relation to the vertical size of the DataWindow object. If you set the Scale.X and Scale.Y properties to 100, the background picture will cover the entire DataWindow object. This property is used only when picture.tilemode is set to 5, 6, 7, or 8. Painter: Background tab, Picture group.
Tranparency	An integer in the range 0 to 100, where 0 means that the background bitmap is opaque and 100 that it is completely transparent. Painter: Background tab, Picture group.

Usage

In the painter

Select the DataWindow object and set the value on the Background tab of the Properties view.

If you save to an EMF or WMF, the properties on the Background tab are not saved with the DataWindow.

This table explains the values for Picture.Mode:

Value	Description
0 - Original Size	The image is centered and not tiled to fit the DataWindow.
1 - Fit to Width	The image is stretched or compressed (depending on the aspect ratio) until its width matches that of the DataWindow control).
2 - Fit to Height	The image is stretch or compressed (depending on the the aspect ratio) until its height matches that of the DataWindow control.
3 - Preserve Aspect Ratio/Max to Rect	The image is stretched or compressed (without distortion) until its width or height matches that of the DataWindow control without either of them exceeding the bounds of the DataWindow control.
4 - Stretch to Fit	The image is stretched to fill the DataWindow control, without preserving the aspect ratio.
5 - Tile	The image is tiled to fill the DataWindow. The number of repetitions will be affected by the values of picture.scale.x, picture.scale.y, and the picture.clip properties.
6 - Flip X	The image is used to fill the DataWindow by tiling and then it is flipped horizontally as you move from one tile to the next in a row. The number of repetitions will be affected by the values of picture.scale.x, picture.scale.y, and the picture.clip properties.
7 - Flip Y	The image is used to fill the DataWindow by tiling and then it is flipped vertically as you move from one tile to the next in a column. The number of repetitions will be affected by the values of picture.scale.x, picture.scale.y, and the picture.clip properties.
8 - Flip XY	The image is used to fill the DataWindow by tiling and then it is flipped horizontally as you move along the rows and vertically as you move along the columns. The number of repetitions will be affected by the values of picture.scale.x, picture.scale.y, and the picture.clip properties.

Examples

dw_1.Modify("datawindow.brushmode=6") 
dw_1.Object.datawindow.picture.File="MyPic.bmp"

Pie.DispAttr.fontproperty

PlotNullData

Description

Whether a continuous line is drawn between tics in a line graph when there is no data on the X and Y axes.

Applies to

Graph controls, Graph DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.PlotNullData

Describe and Modify argument:

"graphname.PlotNullData { = ' value ' }"

Parameter

Description

graphname

The name of the graph control in the DataWindow object for which you want to get or set the perspective.

value

A boolean number indicating whether a continuous line is drawn between tics in a line graph when there is no data.

Values are:

0 -- (False) The line is broken when there is no data.

1 -- (True) The line is continuous.

Usage

In the painter

Set the value in the Properties view, General tab, PlotNullData check box (available when a line graph type is selected).

Examples

string setting
setting = dw1.Object.graph_1.PlotNullData
dw1.Object.graph_1.PlotNullData = 1
setting = dw1.Describe("graph_1.PlotNullData")
dw1.Modify("graph_1.PlotNullData=1")

Pointer

Description

The image to be used for the mouse pointer when the pointer is over the specified control. If you specify a pointer for the whole DataWindow, PowerBuilder uses that pointer except when the pointer is over a control that also has a Pointer setting.

Applies to

DataWindow, Button, Column, Computed Field, Graph, GroupBox, Line, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Pointer

Describe and Modify argument:

"controlname.Pointer { = 'pointername ' }"

Parameter	Description
controlname	The name of the control in the DataWindow for which you want to get or set the pointer. Specify DataWindow to specify the pointer for the whole DataWindow.
pointername	(exp) A string specifying a value of the Pointer enumerated datatype or the name of a cursor file (.CUR) to be used for the pointer. (See the section called “SetPointer” in PowerScript Reference for a list of Pointer values.) Pointername can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Pointer tab.

Examples

setting = dw1.Object.graph_1.Pointer
dw1.Object.graph_1.Pointer = 'Cross!'
setting = dw1.Describe("graph_1.Pointer")
dw1.Modify("graph_1.Pointer = 'Cross!'")
dw1.Modify("graph_1.Pointer = 'c:\pb040\mycurs.cur'")

Print.Preview.property

Description

Properties that control the print preview of a DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Print.Preview.property

Describe and Modify argument:

"DataWindow.Print.Preview.property { = value }"

SyntaxFromSql:

DataWindow ( Print.Preview.property = value )

Parameter	Description
property	A property for print preview. Properties and their settings are listed in the table below.
value	The value to be assigned to the property. Value cannot be a DataWindow expression.

Property for Print.Preview	Value
Buttons	Whether buttons display in print preview. Values are: Yes -- Buttons are displayed. No -- (Default) Buttons are not displayed. Painter: Display Buttons - Print Preview.
Outline	Whether a blue line displays to show the location of the margins. Values are: Yes -- (Default) Margin outline is displayed. No -- Margin outline is not displayed. Painter: Print Preview Shows Outline
Rulers	Whether the rulers display when the DataWindow object displays in preview mode. Values are: Yes -- Display the rulers. No -- (Default) Do not display the rulers. You can view rulers in Preview mode in the DataWindow painter. With the Preview view selected, select File>Print Preview, then File>Print Preview Rulers. However, the setting is not used at runtime. To see rulers at runtime, set Print.Preview.Rulers in code.
Zoom	An integer indicating the zoom factor of the print preview. The default is 100%. You can view different zoom percentages in Preview mode in the DataWindow painter. With the Preview view selected, select File>Print Preview, then File>Print Preview Zoom. However, the setting is not used at runtime. To change the zoom factor at runtime, set Print.Preview.Zoom in code.

Usage

In the painter

Select the DataWindow by deselecting all controls; then set values in the Properties view, Print Specifications tab.

Examples

dw1.Object.DataWindow.Print.Preview.Buttons = 'Yes'
setting = dw1.Describe ("DataWindow.Print.Preview.Buttons")
dw1.Modify("DataWindow.Print.Preview.Buttons = 'Yes'")
dw1.Object.DataWindow.Print.Preview.Rulers = 'Yes'
setting = dw1.Describe ("DataWindow.Print.Preview.Rulers")
dw1.Modify("DataWindow.Print.Preview.Rulers = 'Yes'")

See also

Description

Properties that control the printing of a DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Print.property

Describe and Modify argument:

"DataWindow.Print.property { = value }"

SyntaxFromSql:

DataWindow ( Print.property = value )

Parameter	Description
property	A property for printing. Properties and their settings are listed in the table below.
value	The value to be assigned to the property. Value cannot be a DataWindow expression.

Property for Print	Value
Background	Whether the background settings of the DataWindow and controls display on the printed report. Values are: Yes -- Display background on report. This feature is not supported when you use a picture as the DataWindow background. No -- (Default) Do not display background on report. Painter: Print Shows Background option.
Buttons	Whether buttons display on the printed output. Values are: Yes -- Buttons are displayed. No -- Buttons are not displayed. Painter: Display Buttons - Print.
CanUseDefaultPrinter	Whether a report can be printed on the default system printer if the printer specified by the PrinterName property is not valid. Painter: Can Use Default Printer option.
ClipText	Whether the text of a static text field on a printed page is clipped to the dimensions of the text field when the text field has no visible border setting. Values are: Yes -- The printed text does not overrun the text field. No -- (Default) The entire text can overrun the text field. Text is automatically clipped for text fields with visible border settings even if this property is not set. Painter: Clip Text option.
Collate	Whether printing is collated. Note that collating is usually slower since the print is repeated to produce collated sets. Values are: Yes -- (Default) Collate the pages of the print job. No -- Do not collate. Painter: Collate Copies option.
Color	An integer indicating whether the printed output will be color or monochrome. Values are: 1 -- Color 2 -- Monochrome The user can specify the value in the system's Print dialog box if the printer driver supports it.
Columns	An integer specifying the number of newspaper-style columns the DataWindow will print on a page. For purposes of page fitting, the whole DataWindow is a single column. The default is 1. Painter: Newspaper Columns Across option.
Columns.Width	An integer specifying the width of the newspaper-style columns in the units specified for the DataWindow. Painter: Newspaper Columns Width option.
Copies	An integer indicating the number of copies to be printed. The user can also specify this value in the system's Print Setup dialog box if the printer driver supports it. If you use both the Print.Copies property and the Print Setup dialog box to indicate that multiple copies should be printed, the total number of copies printed is the product of the two values.
CustomPage.Length	A long indicating the desired length of a custom paper size for printing. Use this property in conjunction with Print.CustomPage.Width and with Paper.Size set to 256.
CustomPage.Width	A long indicating the desired width of a custom paper size for printing. Use this property in conjunction with Print.CustomPage.Length and with Paper.Size set to 256.
DocumentName	A string containing the name that will display in the print queue when the user sends the contents of the DataWindow object to the printer. Painter: Document Name option.
Duplex	An integer indicating duplex or double-sided printing for printers capable of duplex printing. Values are: 0 -- Default 1 -- Normal (nonduplex) printing 2 -- Short-edge binding (the long edge of the page is horizontal) 3 -- Long-edge binding (the long edge of the page is vertical) The user can specify the value in the system's Print dialog box if the printer driver supports it.
Filename	A string containing the name of the file to which you want to print the report. An empty string means send to the printer. Painter: Cannot be set in painter.
Margin.Bottom	An integer indicating the width of the bottom margin on the printed page in the units specified for the DataWindow. You can set Margin.Bottom when using SyntaxFromSql to generate DataWindow syntax. Painter: Bottom Margin option.
Margin.Left	An integer indicating the width of the left margin on the printed page in the units specified for the DataWindow. You can set Margin.Left when using SyntaxFromSql to generate DataWindow syntax. Painter: Left Margin option.
Margin.Right	An integer indicating the width of the right margin on the printed page in the units specified for the DataWindow. You can set Margin.Right when using SyntaxFromSql to generate DataWindow syntax. Painter: Right Margin option.
Margin.Top	An integer indicating the width of the top margin on the printed page in the units specified for the DataWindow. You can set Margin.Top when using SyntaxFromSql to generate DataWindow syntax. Painter: Top Margin option.
Orientation	An integer indicating the print orientation. This property has no effect if the computer has no default printer. Values are: 0 -- The default orientation for your printer 1 -- Landscape 2 -- Portrait Painter: Paper Orientation option.
OverridePrintJob	Whether you want to override the print job print settings defined in the PrintOpen method with the print specifications of the DataWindow. Values are: Yes -- Override the print job print settings. No -- (Default) Do not override the print job print settings. Painter: Override Print Job option.
Page.Range	A string containing the numbers of the pages you want to print, separated by commas. You can also specify a range with a dash. For example, to print pages 1, 2, and 5 through 10, enter: "1,2, 5-10". The empty string means print all. The user can specify the value in the system's Print dialog box if the printer driver supports it.
Page.RangeInclude	An integer indicating what pages to print within the desired range. Values are: 0 -- Print all. 1 -- Print all even pages. 2 -- Print all odd pages. The user can specify the value in the system's Print dialog box if the printer driver supports it.
Paper.Size	An integer indicating the size of the paper used for the output: 0 -- Default paper size for the printer 1 -- Letter 8 1/2 x 11 in 2 -- LetterSmall 8 1/2 x 11 in 3 -- Tabloid 17 x 11 in 4 -- Ledger 17 x 11 in 5 -- Legal 8 1/2 x 14 in 6 -- Statement 5 1/2 x 8 1/2 in 7 -- Executive 7 1/4 x 10 1/2 in 8 -- A3 297 x 420 mm 9 -- A4 210 x 297 mm 10 -- A4 Small 210 x 297 mm 11 -- A5 148 x 210 mm 12 -- B4 250 x 354 mm 13 -- B5 182 x 257 mm 14 -- Folio 8 1/2 x 13 in 15 -- Quarto 215 x 275 mm 16 -- 10x14 in 17 -- 11x17 in 18 -- Note 8 1/2 x 11 in 19 -- Envelope #9 3 7/8 x 8 7/8 20 -- Envelope #10 4 1/8 x 9 1/2 21 -- Envelope #11 4 1/2 x 10 3/8 22 -- Envelope #12 4 x 11 1/276 23 -- Envelope #14 5 x 11 1/2 24 -- C size sheet 25 -- D size sheet 26 -- E size sheet 27 -- Envelope DL 110 x 220 mm 28 -- Envelope C5 162 x 229 mm 29 -- Envelope C3 324 x 458 mm 30 -- Envelope C4 229 x 324 mm 31 -- Envelope C6 114 x 162 mm 32 -- Envelope C65 114 x 229 mm 33 -- Envelope B4 250 x 353 mm 34 -- Envelope B5 176 x 250 mm 35 -- Envelope B6 176 x 125 mm 36 -- Envelope 110 x 230 mm 37 -- Envelope Monarch 3.875 x 7.5 in 38 -- 6 3/4 Envelope 3 5/8 x 6 1/2 in 39 -- US Std Fanfold 14 7/8 x 11 in 40 -- German Std Fanfold 8 1/2 x 12 in 41 -- German Legal Fanfold 8 1/2 x 13 in 255, 256 -- User-defined paper size (see "Usage" below) Painter: Paper Size option.
Paper.Source	An integer indicating the bin that will be used as the paper source. The integer you use depends on the tray number used by the printer. (To determine the actual bin setting, you can query the printer with a utility that makes API calls to the printer driver.) Typical values are: 0 -- Default 1 -- Upper 2 -- Lower 3 -- Middle 4 -- Manual 5 -- Envelope 6 -- Envelope manual 7 -- Auto 8 -- Tractor 9 -- Smallfmt 10 -- Largefmt 11 -- Large capacity 14 -- Cassette Painter: Paper Source option.
Preview	Whether the DataWindow object is displayed in preview mode. Values are: Yes -- Display in preview mode. No -- (Default) Do not display in preview mode.
Preview.Background	Whether the background settings of the DataWindow and controls display in the print preview. Values are: Yes -- Display in preview mode. No -- (Default) Do not display in preview mode. Painter: Preview Shows Background option.
PrinterName	A string containing the name of the printer you want to use to print the DataWindow report. If the printer name is not specified or if the named printer cannot be found at runtime, print output can be directed to the default printer for the user's machine by setting the CanUseDefaultPrinter property. Otherwise, an error is returned. Painter: Printer Name option.
Prompt	Whether a Printer Setup dialog displays before a job prints so the user can change the paper or other settings for the current printer. Values are: Yes -- (Default) Display a Printer Setup dialog. No -- Do not display a Printer Setup dialog. Choosing Cancel in the Printer Setup dialog dismisses the Setup dialog; it does not cancel printing. To allow the user to cancel printing, see the Print method. For DataStores, this property is ignored; a dialog is never displayed. Painter: Prompt Before Printing check box.
Quality	An integer indicating the quality of the output. Values are: 0 -- Default 1 -- High 2 -- Medium 3 -- Low 4 -- Draft The user can specify the value in the system's Print dialog box if the printer driver supports it.
Scale	An integer specifying the scale of the printed output as a percent. The scaling percentage is passed to the print driver. If you have problems with scaling, you might be using a driver that does not support scaling. The user can specify the value in the system's Print dialog box if the printer driver supports it. For more information, see your print driver documentation.

Usage

In the painter

Select the DataWindow by deselecting all controls; then set values in the Properties view, Print Specifications tab.

To specify a user-defined paper size, set the Paper.Size property to 255 or 256, then set the Print.CustomPage.Length and Print.Custom.Page.Width properties to the desired size. With Paper.Size set to 255, Length and Width are in the units specified for the DataWindow on the General page in the Properties view. For example:

// DataWindow Units set to 1/1000 inch
dw1.Modify("DataWindow.Print.Paper.Size=255")
//9.875 inches long
dw1.Modify("DataWindow.Print.CustomPage.Length=9875")
//7.375 inches wide
dw1.Modify("DataWindow.Print.CustomPage.Width=7375")

With Paper.Size set to 256, Length and Width are in millimeters:

dw1.Modify("DataWindow.Print.Paper.Size=256")
//25.4 centimeters long
dw1.Modify("DataWindow.Print.CustomPage.Length=254")
//19.5 centimeters wide
dw1.Modify("DataWindow.Print.CustomPage.Width=195")

Examples

strData = dw1.Object.DataWindow.Print.Scale
dw1.Object.DataWindow.Print.Paper.Size = 3
strData = dw1.Describe("DataWindow.Print.Scale")
dw1.Modify("DataWindow.Print.Paper.Size = 3")
dw1.Modify("DataWindow.Print.Margin.Top=500")
dw1.Object.DataWindow.Print.Buttons = 'Yes'
setting = dw1.Describe("DataWindow.Print.Buttons")
dw1.Modify("DataWindow.Print.Buttons = 'Yes'")

See also

Print.Preview.property

Printer

Description

The name of the printer for printing the DataWindow as specified in the system's printer selection dialog box.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Printer = "printername"

Describe and Modify argument:

"DataWindow.Printer" { = printername }"

Parameter	Description
printername	Name of the printer you want to use for your DataWindow

Usage

The printer you select for a DataWindow does not affect the PowerBuilder default printer or the system default printer. To specify a network-connected printer, you must use a fully specified network printer name:

dw1.Object.DataWindow.Printer = "\\net-print\pr-6"

If you specify a DataWindow printer, but the printer is not found, the DataWindow engine does not attempt to print to a default device.

Examples

The following example changes the DataWindow printer (but does not affect the system default printer device):

dw1.Modify ('DataWindow.Printer="My LaserJet 3" ')

You can display the DataWindow printer with either of the following calls:

string ls_dwprinter
ls_dwprinter = dw1.Object.DataWindow.Printer
ls_dwprinter = dw1.Describe("DataWindow.Printer")

Processing

Description

The type of processing required to display the data in the selected presentation style.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Processing

Describe argument:

"DataWindow.Processing"

Return values are:

0 -- (Default) Form, group, n-up, or tabular

1 -- Grid

2 -- Label

3 -- Graph

4 -- Crosstab

5 -- Composite

6 -- OLE

7 -- RichText

8 -- TreeView

9 -- TreeView with Grid

Examples

string setting
setting = dw1.Object.DataWindow.Processing
setting = dw1.Describe("DataWindow.Processing")

Protect

Description

The protection setting of a column. The Protect property overrides tab order settings. When a column is protected, the user cannot edit it even if the column's tab order is greater than 0.

Applies to

A column

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.Protect

Describe and Modify argument:

"columnname.Protect { = ' integer ' }"

Parameter

Description

columnname

The name of the column for which you want to get or set the protection.

integer

(exp) A boolean integer specifying whether the column is protected.

Values are:

0 -- False, the column is not protected.

1 -- True, the column is protected.

Integer can be a quoted DataWindow expression.

Usage

A user cannot change a column value if any one of these conditions is true:

TabSequence is 0
Edit.DisplayOnly is Yes when the column has the Edit edit style
Protect is 1

Only the Protect property allows you to specify a conditional expression that protects some values in the column but not others.

In the painter

Select the control and set the value in the Properties view, General tab (using a conditional expression).

Examples

string setting
setting = dw1.Object.emp_stat.Protect
dw1.Object.emp_stat.Protect=1
setting = dw1.Describe("emp_stat.Protect")
dw1.Modify("emp_stat.Protect=1")
dw1.Modify("emp_stat.Protect='1~tIf(IsRowNew(),0,1)'")

QueryClear

Description

Removes the WHERE clause from a query. Note that the only valid setting is Yes.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.QueryClear

Modify argument:

"DataWindow.QueryClear { = value }"

Parameter

Description

value

Remove the WHERE clause from a query.

Yes is the only valid value.

Examples

dw1.Object.DataWindow.QueryClear = "yes"
dw1.Modify("DataWindow.QueryClear=yes")

QueryMode

Description

Whether the DataWindow is in query mode. In query mode, the user can specify the desired data by entering WHERE criteria in one or more columns.

DataWindow presentation styles

You cannot use QueryMode with DataWindow objects that use any of the following presentation styles: N-Up, Label, Crosstab, RichText, and Graph.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.QueryMode

Describe and Modify argument:

"DataWindow.QueryMode { = value }"

Parameter

Description

value

Whether the DataWindow is in query mode.

Values are:

yes -- Query mode is enabled.

no -- Query mode is disabled.

Usage

After the user specifies retrieval criteria in query mode, subsequent calls to Retrieve can use the new criteria. To retrieve data based on user selection, change the query mode back to no and use AcceptText to accept the user's specification before the next call to Retrieve.

Setting QuerySort to yes also puts the DataWindow into query mode, changing the QueryMode property's value to yes.

Query mode and secondary DataWindows

When you are sharing data, you cannot turn on query mode for a secondary DataWindow. Trying to set the QueryMode or QuerySort properties results in an error.

Buffer manipulation and query mode

A DataWindow cannot be in query mode when you call the RowsCopy method.

Examples

string setting
setting = dw1.Object.DataWindow.QueryMode
dw1.Object.DataWindow.QueryMode = "yes"
setting = dw1.Describe("DataWindow.QueryMode")
dw1.Modify("DataWindow.QueryMode=yes")

QuerySort

Description

Whether the result set is sorted when the DataWindow retrieves the data specified in query mode. When query sort is on, the user specifies sorting criteria in the first row of the query form.

DataWindow presentation styles

You cannot use QuerySort with DataWindow objects that use any of the following presentation styles: N-Up, Label, Crosstab, RichText, and Graph.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.QuerySort

Describe and Modify argument:

"DataWindow.QuerySort { = value }"

Parameter

Description

value

Whether the data retrieved from query mode specifications is sorted.

Values are:

Yes -- Sorting is enabled.

No -- Sorting is disabled.

Usage

If the DataWindow is not already in query mode, setting QuerySort to Yes also sets QueryMode to Yes, putting the DataWindow in query mode.

When you set QuerySort to No, the DataWindow remains in query mode until you also set QueryMode to No.

Query mode and secondary DataWindows

When you are sharing data, you cannot turn on query mode for a secondary DataWindow. Trying to set the QueryMode or QuerySort properties results in an error.

Examples

string setting
setting = dw1.Object.DataWindow.QuerySort
dw1.Object.DataWindow.QuerySort = "yes"
setting = dw1.Describe("DataWindow.QuerySort")
dw1.Modify("DataWindow.QuerySort=yes")

RadioButtons.property

Description

Properties that control the appearance and behavior of a column with the RadioButton edit style.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.RadioButtons.property

Describe and Modify argument:

"columnname.RadioButtons.property { = value }"

Parameter	Description
columnname	The name of the column that has the RadioButton edit style.
property	A property for the RadioButton column. Properties and their settings are listed in the table below.
value	The value to be assigned to the property. For RadioButton properties, value cannot be a DataWindow expression.

Property for RadioButtons	Value
3D or ThreeD	Whether the radio buttons are 3D. Values are: Yes -- Make the buttons 3D. No -- Do not make the buttons 3D. Painter: 3D Look option. When using dot notation, use the term ThreeD instead of 3D.
Columns	An integer constant specifying the number of columns of radio buttons. Painter: Columns Across option.
LeftText	Whether the text labels for the radio buttons are on the left side. Values are: Yes -- The text is on the left of the radio buttons. No -- The text is on the right of the radio buttons. Painter: Left Text option.
Scale	Whether the circle is scaled to the size of the font. Scale has an effect only when 3D is No. Values are: Yes -- Scale the circles. No -- Do not scale the circles. Painter: Scale Circles option.

Usage

In the painter

Select the control and set the value in the Properties view, Edit tab when Style Type is RadioButtons.

Examples

setting = dw1.Describe("empg.RadioButtons.LeftText")
dw1.Modify("emp_gender.RadioButtons.LeftText=no")
dw1.Modify("emp_gender.RadioButtons.3D=Yes")
dw1.Modify("emp_gender.RadioButtons.Columns=2")
string setting
setting = &
   dw1.Object.emp_gender.RadioButtons.LeftText
dw1.Object.emp_gender.RadioButtons.LeftText = "no"

Range

Description

The rows in the DataWindow used in the graph or OLE Object control. Range can be all rows, the rows on the current page, a group that you have defined for the DataWindow, or the current row (OLE Object controls only).

Applies to

Graph and OLE Object controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Range

Describe argument:

"controlname.Range"

Parameter	Description
controlname	The name of the graph control within the DataWindow that will display the graphed rows or the name of the OLE Object control that holds an OLE object to which the specified range of rows will be transferred.

Usage

Possible values are:

-2 -- The current row (OLE Object controls only)

-1 -- The rows on a single page in the DataWindow object

0 -- All the rows in the DataWindow object

n -- The number of a group level in the DataWindow object

GroupBy and Target also affect the data that is transferred to the OLE object.

In the painter

Select the control and set the value in the Properties view, Data tab, Rows option.

Examples

string strRange
strRange = dw1.Object.graph_salary.Range
strRange = dw1.Object.ole_report.Range
strRange = dw1.Describe("graph_salary.Range")
strRange = dw1.Describe("ole_report.Range")

ReadOnly

Description

Whether the DataWindow is read-only.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.ReadOnly

Describe and Modify argument:

"DataWindow.ReadOnly { = value }"

Parameter

Description

value

Whether the DataWindow is read-only.

Values are:

Yes -- Make the DataWindow read-only.

No -- (Default) Do not make the DataWindow read-only.

Examples

string setting
setting = dw1.Object.DataWindow.ReadOnly
dw1.Object.DataWindow.ReadOnly="Yes"
setting = dw1.Describe("DataWindow.ReadOnly")
dw1.Modify("DataWindow.ReadOnly=Yes")

Render3D

Description

Whether the GraphType is rendered in the DirectX 3D style.

Applies to

Graph controls and Graph DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Render3D

Describe and Modify argument:

"graphname.Render3D { = ' boolean ' }

Parameter

Description

graphname

The graph control for which you want to get or change the type.

Graph types that can use the new 3D rendering style are:

3 -- Bar 3D

8 -- Col3D

15 -- Area3D

16 -- Line3D

17 -- Pie3D

boolean

0 = Original 3D style

1 = New 3D rendering style

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

The following statement sets a graph control to the DirectX 3D style.

gr_1.Render3D=true

The following statement sets a DataWindow in the graph presentation style to the DirectX 3D style.

dw_1.Object.gr_1.Render3D=true

ReplaceTabWithSpace

Description

Whether tab characters embedded in the data for a DataWindow display as square boxes when the row is not the current row.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.ReplaceTabWithSpace

Describe and Modify argument:

"DataWindow.ReplaceTabWithSpace { = value }"

Parameter

Description

value

Whether tab characters embedded in the data for a DataWindow are replaced with spaces.

Values are:

Yes -- Replace each tab character with four spaces.

No -- (Default) Do not replace tab characters.

Examples

string str
str = dw1.Object.DataWindow.ReplaceTabWithSpace
dw1.Object.DataWindow.ReplaceTabWithSpace="Yes"
str = dw1.Describe("DataWindow.ReplaceTabWithSpace")
dw1.Modify("DataWindow.ReplaceTabWithSpace=Yes")

Report

Description

Whether the DataWindow is a read-only report.

Applies to

Style keywords

Syntax

SyntaxFromSql:

Style ( Report = value )

Parameter

Description

value

Whether the DataWindow is a read-only report, similar to a DataWindow created in the Report painter.

Values are:

Yes -- The DataWindow is a read-only report.

No -- The DataWindow is not read-only.

Examples

SQLCA.SyntaxFromSQL(sqlstring, &
'Style(...Report = yes ...)', errstring)

ResetPageCount

Description

Specifies that a change in the value of the group column causes the page count to begin again at 0.

Applies to

Group keywords

Syntax

SyntaxFromSql:

Group (col1 {col2 ...} ... ResetPageCount )

Examples

SQLCA.SyntaxFromSQL(sql_syntax, &
   "Style(Type=Group) " + &
   "Group(#3 NewPage ResetPageCount)", &
   errorvar)

Resizeable

Description

Whether the user can resize the specified control.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Line, OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Resizeable

Describe and Modify argument:

"controlname.Resizeable { = value }"

Parameter

Description

controlname

The control within the DataWindow whose Resizeable setting you want to get or set.

value

A boolean number indicating whether controlname can be resized.

Values are:

0 -- (False) The control cannot be resized.

1 -- (True) The control can be resized.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab.

When you make the control resizable, set the Border property to the resizable border so the user knows it is resizable.

Examples

string setting
setting = dw1.Object.graph_1.Resizeable
dw1.Object.graph_1.Resizeable = 1
setting = dw1.Describe("graph_1.Resizeable")
dw1.Modify("graph_1.Resizeable=1")
dw1.Modify("bitmap_1.Resizeable=0")

Retrieve

Description

The SQL statement for the DataWindow.

Retrieve is set in DataWindow syntax only for the Create method.

Applies to

Table keywords

Syntax

Table ( ... Retrieve = selectstatement ... )

Retrieve.AsNeeded

Description

Whether rows will be retrieved only as needed from the database. After the application calls the Retrieve method to get enough rows to fill the visible portion of the DataWindow, additional rows are "needed" when the user scrolls down to view rows that have not been viewed yet.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Retrieve.AsNeeded

Describe and Modify argument:

"DataWindow.Retrieve.AsNeeded { = 'value ' }"

Parameter

Description

value

Whether rows will be retrieved only as needed from the database.

Values are:

Yes -- Rows will be retrieved only as needed.
No -- All rows will be retrieved when the Retrieve method is called.

Usage

In the painter

Set the value using Rows>Retrieve Options>Rows As Needed.

Examples

string setting
setting = dw1.Object.DataWindow.Retrieve.AsNeeded
dw1.Object.DataWindow.Retrieve.AsNeeded= "Yes"
setting = dw1.Describe("DataWindow.Retrieve.AsNeeded")
dw1.Modify("DataWindow.Retrieve.AsNeeded=Yes")

RichEdit.property

Description

Settings that affect the appearance and behavior of columns whose edit style is RichText.

Applies to

Column controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.RichEdit.property

Describe and Modify argument:

"columnname.RichEdit.property { = value }"

SyntaxFromSql:

Column ( RichEdit.property = value )

Parameter	Description
columnname	The column with the RichText edit style for which you want to get or set property values. You can specify the column name or a pound sign (#) and the column number.
property	A property for the column's Edit style. Properties and their settings are listed in the table below. The table identifies the properties you can use with SyntaxFromSql.
value	The value to be assigned to the property.

Property for RichEdit	Value
AutoSelect	Whether to select the contents of the column control automatically when it receives focus. Values are: Yes -- Select automatically. No -- Do not select automatically. You can use AutoSelect with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Auto Selection option
DisplayOnly	Whether the column is display only. Values are: Yes -- Do not allow the user to enter data; make the column display only. No -- Allow the user to enter data. Painter: Display Only option For conditional control over column editing, use the Protect property.
FocusRectangle	Whether a dotted rectangle (the focus rectangle) surrounds the current row of the column when the column has focus. Values are: Yes -- Display the focus rectangle. No -- Do not display the focus rectangle. You can use FocusRectangle with SyntaxFromSql. The setting applies to all the columns in the generated syntax. Painter: Show Focus Rectangle option
Limit	A number specifying the maximum number of characters (0 to 32,767) that the user can enter. 0 means unlimited. Painter: Limit option.
NilIsNull	Whether to set the value of the column control to null when the user leaves it blank. Values are: Yes -- Make the empty string null. No -- Do not make the empty string null. Painter: Empty String is Null option.
Required	Whether the column is required. Values are: Yes -- It is required. No -- It is not required. Painter: Required option.
VScrollBar	Whether a vertical scroll bar displays in the column control. Values are: Yes -- Display vertical scroll bars. No -- Do not display vertical scroll bars. Painter: Vertical Scroll Bar option.

Usage

In the painter

Select the control and set values in the Properties view, Edit tab, when Style Type is RichText.

Examples

string setting
setting = &
   dw_1.Object.rte_description.RichEdit.AutoSelect
dw_1.Object.rte_description.RichEdit.VScrollBar="yes"
setting = dw_1.Describe(&
   "rte_description.RichEdit.VScrollBar")
dw_1.Modify("rte_description.RichEdit.Required=no")

RichText.property

Description

Properties for the DataWindow RichText presentation style.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.RichText.property

Describe and Modify argument:

"DataWindow.RichText.property { = value }"

Parameter	Description
property	A property for the DataWindow RichText presentation style. Properties and appropriate values are listed in the table below.
value	A value to be assigned to the property.

Property for RichText	Value
BackColor	A long specifying the numeric value of the background color of the text editing area. Values are -2 to 16,777,215. For more information about color, see RGB. Painter: Background Color group, General option.
ControlCharsVisible	Specifies whether control characters (carriage returns, spaces, and tabs) are visible. Values are: Yes -- Control characters are visible. No -- Control characters are hidden. Painter: RichText Presentation group, ControlChars Visible option.
DisplayOnly	Specifies whether users can make changes to the contents. Values are: Yes -- The content, including text and input files, is protected (the user cannot edit it). No -- The user can edit the content. Painter: Display Only option.
HeaderFooter	(Read-only) Specifies whether the RichTextEdit DataWindow has a header/footer section. This property must be set in the painter and cannot be changed at runtime. Values are: Yes -- The control has a header/footer section. No -- The control does not have a header/footer section. If a document has a header or footer and the HeaderFooter property is set to no, then header/footer information in the document is ignored. If the document is then saved in the same file, the header/footer information is lost. Painter: Header/Footer option.
InputField BackColor	A long specifying the default background color for all input fields: -2 to 16,777,215. Painter: Background Color group, Input Field option.
InputField NamesVisible	Specifies whether input field names are displayed in input fields, rather than the input field values. Values are: Yes -- Input fields display. No -- Input fields do not display. The value you specify is ignored when the InputFieldsVisible property is set to false. Painter: RichText Presentation group, Input Field Names Visible option.
InputFields Visible	Specifies whether input fields display in the DataWindow object. Values are: Yes -- Input fields display their names. No -- Input fields display their data. Painter: RichText Presentation group, Input Fields Visible option.
PictureFrame (obsolete)	(Obsolete) This property is no longer supported since PowerBuilder 12.6. Specifies whether pictures are displayed as empty frames. Values are: Yes -- Pictures are displayed as empty frames. No -- The pictures are displayed. Painter: Pictures As Frame option.
PopMenu	Specifies whether the user has access to a pop-up menu by clicking the right mouse button on the DataWindow. The menu allows the user to cut and paste, insert a file, and select formatting options. Values are: Yes -- Pop-up menu is enabled. No -- Pop-up menu is disabled. Painter: PopUp Menu option.
ReadOnly	Specifies whether the user can change the data and the text in the DataWindow. Values are: Yes -- The DataWindow is read-only (text and data cannot be modified). No -- The text and the data can be modified.
ReturnsVisible (obsolete)	Replaced by RichText.ControlCharsVisible property.
RulerBar	Specifies whether a ruler bar is visible above the editing area. If visible, the user can use it to see measurements while setting tabs and margins on the tab bar (see the TabBar property in this table). Values are: Yes -- Ruler bar is visible. No -- Ruler bar is hidden. If the RichTextEdit pop-up menu is enabled, the user can use it to turn ruler bar display on and off (see the PopMenu property in this table). Painter: RichText Bars group, Ruler option.
SpacesVisible	Specifies whether spaces are visible. Values are: Yes -- Spaces are visible. No -- Spaces are hidden. Painter: RichText Presentation group, Spaces Visible option.
TabBar (obsolete)	(Obsolete) This property is no longer supported since PowerBuilder 12.6. Specifies whether a bar for setting tabs is visible above the editing area. Values are: Yes -- Tab bar is visible. No -- Tab bar is hidden. If the pop-up menu is enabled, the user can use it to turn tab bar display on and off (see the PopMenu property in this table). Painter: RichText Bars group, Tab option.
TabsVisible	Specifies whether tabs are visible. Values are: Yes -- Spaces are visible. No -- Spaces are hidden. Painter: RichText Presentation group, Tabs Visible option.
ToolBar	Specifies whether a tool bar for formatting text is visible above the editing area. Values are: Yes -- Tool bar is visible. No -- Tool bar is not visible. If the pop-up menu is enabled, the user can use it to turn tool bar display on and off (see the PopMenu property in this table). Painter: RichText Bars group, Tool option.
WordWrap	Determines whether large blocks of text that do not contain spaces wrap automatically to the next line when the line reaches the margin. Values are: Yes -- Automatic word wrap is enabled. No -- Automatic word wrap is disabled. Users cannot enter characters beyond the right margin, and must move the cursor to a new line to continue entering text. If an inserted document conatins a block of text too large to fit on a line, the nonfitting characters are hidden. Painter: Word Wrap option

Usage

In the painter

Select the DataWindow by deselecting all controls; then set the value in the Properties view, General tab, when the presentation style is RichText.

Examples

string setting
setting = &
   dw1.Object.DataWindow.RichText.DisplayOnly
dw1.Object.DataWindow.RichText.PopMenu = "yes"
setting = &
   dw1.Describe("DataWindow.RichText.DisplayOnly")
dw1.Modify("DataWindow.RichText.PopMenu = 'yes'")

RightToLeft

Description

The RightToLeft property is used to set controls to read right-to-left. This property is for use when you are developing an application for a language that has right-to-left reading order.

Applies to

Column

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.RightToLeft

Describe and Modify argument:

"controlname.RightToLeft { = integer }"

Parameter	Description
controlname	The name of the control for which you want to get or set the right-to-left property.
integer	Whether the control is set to right-to-left: 0 -- (False) The control is not set to right-to-left 1 -- (True) The control is set to right-to-left

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

dw_1.Object.fname.RightToLeft=1

Rotation

Description

The degree of left-to-right rotation for the graph control within the DataWindow when the graph has a 3D type.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Rotation

Describe and Modify argument:

"graphname.Rotation = { 'integer ' }"

Parameter	Description
graphname	The name of the Graph control for which you want to get or set the rotation.
integer	(exp) The degree of rotation for the graph. Effective values range from -90 to 90. Integer can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Rotation scroll bar (enabled when a 3D graph type is selected).

Examples

string setting
setting = dw1.Object.graph_1.Rotation
dw1.Object.graph_1.Rotation=25
setting = dw1.Describe("graph_1.Rotation")
dw1.Modify("graph_1.Rotation=25")
dw1.Modify("graph_1.Rotation='1~tHour(Now())'")

Row.Resize

Description

Whether the user can use the mouse to change the height of the rows in the detail area of the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Row.Resize

Describe and Modify argument:

"DataWindow.Row.Resize { = value } "

Parameter	Description
value	Whether the user can resize the rows in the detail area. Values are: 1 -- Yes, the user can resize the rows. 0 -- No, the user cannot resize the rows.

Usage

In the painter

Select the DataWindow by deselecting all controls; then set the value in the Properties view, General tab, Row Resize option (available when the presentation style is Grid or Crosstab).

Examples

string setting
setting = dw1.Object.DataWindow.Row.Resize
dw1.Object.DataWindow.Row.Resize = 0
setting = dw1.Describe("DataWindow.Row.Resize")
dw1.Modify("DataWindow.Row.Resize=0")

Rows_Per_Detail

Description

The number of rows in the detail area of an n-up DataWindow object. This property should be 1 unless the Type property for the Style keyword is Tabular.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Rows_Per_Detail

Describe argument:

"DataWindow.Rows_Per_Detail"

SyntaxFromSql:

DataWindow ( ... Rows_Per_Detail = n ... )

Parameter	Description
n	A long specifying the number of rows in each column

Examples

SQLCA.SyntaxFromSQL(sqlselect, &
   'DataWindow(...Rows_Per_Detail = 12 ...)', &
   errstring)

Selected

Description

A list of selected controls within the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Selected

Describe and Modify argument:

"DataWindow.Selected = 'list ' "

Parameter

Description

list

A list of the controls you want to select. In the list you designate a group of controls by specifying a range of row numbers and a range of controls in the format:

startrow/endrow/startcontrol/endcontrol

To specify more than one group, separate each group with a semicolon:

startrow1/endrow1/startobj1/endobj1;startrow2/endrow2/startobj2/endobj2;...

Do not include spaces in the string. You must use column names, not column numbers.

Examples

setting = dw1.Object.DataWindow.Selected
dw1.Object.DataWindow.Selected = &
"1/10/emp_id/emp_name;12/23/salary/status"
setting = dw1.Describe("DataWindow.Selected")
dw1.Modify("DataWindow.Selected="  &
"'1/10/emp_id/emp_name;12/23/salary/status'")

Selected.Data

Description

A list describing the selected data in the DataWindow. Each column's data is separated by a tab and each row is on a separate line.

Applies to

DataWindows (Crosstab and Grid presentation styles only)

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Selected.Data

Describe argument:

"DataWindow.Selected.Data"

Examples

string setting
setting = dw1.Object.DataWindow.Selected.Data
setting = dw1.Describe("DataWindow.Selected.Data")

Selected.Mouse

Description

Whether the user can use the mouse to select columns.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Selected.Mouse

Describe and Modify argument:

"DataWindow.Selected.Mouse { = value }"

Parameter

Description

value

Whether the user can use the mouse to select columns.

Values are:

Yes -- The mouse can be used.
No -- The mouse cannot be used.

Usage

In the painter

Select the DataWindow by deselecting all controls; then set the value in the Properties view, General tab, Mouse Selection option (available when the presentation style is Grid or Crosstab).

Examples

string setting
setting = dw1.Object.DataWindow.Selected.Mouse
dw1.Object.DataWindow.Selected.Mouse = "Yes"
setting = dw1.Describe("DataWindow.Selected.Mouse")
dw1.Modify("DataWindow.Selected.Mouse = Yes")

Series

See Axis, Axis.property, and DispAttr.fontproperty.

ShadeColor

Description

The color used for shading the back edge of the series markers when the graph's type is 3D. ShadeColor has no effect unless Series.ShadeBackEdge is 1 (Yes). If ShadeBackEdge is 0, the axis plane is the same color as the background color of the graph.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.ShadeColor

Describe and Modify argument:

"graphname.ShadeColor { = ' long ' }"

Parameter

Description

graphname

The Graph control in the DataWindow for which you want to shade color.

long

(exp) A long number converted to a string specifying the color of the shading for axes of a 3D graph.

You can use the RGB function in a DataWindow expression or in PowerScript to calculate the desired color value. However, be sure to convert the return value of the PowerScript function to a string.

Long can be a quoted DataWindow expression.

Usage

To set the shade color for individual series markers, such as bars or pie slices, use the method SetDataStyle.

In the painter

Select the control and set the value in the Properties view, General tab, Shade Color option.

Examples

string setting
setting = dw1.Object.graph_1.ShadeColor
dw1.Object.graph_1.ShadeColor = 16600000
setting = dw1.Describe("graph_1.ShadeColor")
dw1.Modify("graph_1.ShadeColor=16600000")
dw1.Modify("graph_1.ShadeColor=String(RGB(90,90,90)))
dw1.Modify("graph_1.ShadeColor='0~t" &
      + If(salary>50000," &
      + String(RGB(100,90,90)) &
      + "," &
      + String(RGB(90,90,100)) &
      + ")'")

ShowBackColorOnXP

Description

Whether the background color that you select for a button displays on Windows XP.

Applies to

DataWindow objects

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.ShowBackColorOnXP

Describe and Modify argument:

"DataWindow.ShowBackColorOnXP{ = value }"

Parameter

Description

value

A boolean value that indicates whether the background color that you select for a button displays on Windows XP.

Values are:

Yes -- Display the background color.

No -- Do not display the background color (default).

Usage

The Background.Color property is not supported for buttons on Windows XP by default because the current XP theme controls the appearance of the button.

In the painter

Set the Show Backcolor on XP property on the General tab of the Properties view for the DataWindow object. The background color you selected will display in Preview mode.

Examples

dw1.Modify("DataWindow.ShowBackColorOnXP = yes")
dw1.Object.DataWindow.ShowBackColorOnXP = "yes"

ShowBackground

Description

Whether the background settings of the report display.

Applies to

Report controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.ShowBackground

Describe and Modify argument:

"controlname.ShowBackground{ = 'value '}"

Parameter

Description

value

A boolean value that indicates whether the report's background color settings display.

Values are:

Yes -- Display the background settings.

No -- Do not display the background settings (default).

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Show Background check box.

Examples

dw1.Modify("r_orders_nested.ShowBackground = yes")
dw1.Object.DataWindow.ShowBackground = "yes"

ShowDefinition

Description

Whether the DataWindow definition will display. The DataWindow will display the column names instead of data.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.ShowDefinition

Describe and Modify argument:

"DataWindow.ShowDefinition { = 'value ' }"

Parameter

Description

value

(exp) Whether the column names will display.

Values are:

Yes -- Display the column names.
No -- Display the data, if any.

Value can be a quoted DataWindow expression.

Examples

string setting
setting = dw1.Object.DataWindow.ShowDefinition
dw1.Object.DataWindow.ShowDefinition = "Yes"
setting = dw1.Describe("DataWindow.ShowDefinition")
dw1.Modify("DataWindow.ShowDefinition=Yes")

SizeToDisplay

Description

Whether the graph should be sized automatically to the display area.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.SizeToDisplay

Describe and Modify argument:

"graphname.SizeToDisplay { = 'value ' }"

Parameter

Description

graphname

The graph control in the DataWindow for which you want to get or set adjustability.

value

(exp) A boolean number specifying whether to adjust the size of the graph to the display.

Values are:

0 -- False, do not adjust the size of the graph.
1 -- True, adjust the size of the graph.

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Size To Display option.

Examples

string setting
setting = dw1.Object.graph_1.SizeToDisplay
dw1.Object.graph_1.SizeToDisplay = 0
setting = dw1.Describe("graph_1.SizeToDisplay")
dw1.Modify("graph_1.SizeToDisplay=0")

SlideLeft

Description

Whether the control moves to the left when other controls to the left leave empty space available. This property is for use with read-only controls and printed reports. It should not be used with data entry fields or controls.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Line, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.SlideLeft

Describe and Modify argument:

"controlname.SlideLeft { = ' value ' }"

Parameter

Description

controlname

The name of the control for which you want to get or set the Slide setting.

value

(exp) Whether the control slides left when there is empty space to its left.

Values are:

Yes -- The control will slide left into available space.
No -- The control will remain in position.

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab, Slide Left check box.

Examples

string setting
setting = dw1.Object.graph_1.SlideLeft
dw1.Object.emp_lname.SlideLeft = "yes"
setting = dw1.Describe("graph_1.SlideLeft")
dw1.Modify("emp_lname.SlideLeft=yes")

SlideUp

Description

Whether the control moves up when other controls above it leave empty space available. This property is for use with read-only controls and printed reports. It should not be used with data entry fields or controls.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Line, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.SlideUp

Describe and Modify argument:

"controlname.SlideUp { = ' value ' }"

Parameter

Description

controlname

The name of the control for which you want to get or set the Slide setting.

value

(exp) How the control slides up when there is empty space above it.

Values are:

AllAbove -- Slide the control up if all the controls in the row above it are empty.
DirectlyAbove -- Slide the column or control up if the controls directly above it are empty.
No -- The control will not slide up.

Value can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Position tab, Slide Up check box.

Examples

string setting
setting = dw1.Object.graph_1.SlideUp
dw1.Object.emp_lname.SlideUp = "no"
setting = dw1.Describe("graph_1.SlideUp")
dw1.Modify("emp_lname.SlideUp=no")

Sort

Description

Sort criteria for a newly created DataWindow. To specify sorting for existing DataWindows, see the SetSort and Sort methods.

Applies to

Table keywords in DataWindow syntax

Syntax

DataWindow syntax for Create method:

Table ( ... Sort = stringexpression ... )

Parameter	Description
stringexpression	A string whose value represents valid sort criteria. See the SetSort method for the format for sort criteria. If the criteria string is null, PowerBuilder prompts for a sort specification when it displays the DataWindow.

Spacing

Description

The gap between categories in a graph.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Spacing

Describe and Modify argument:

"graphname.Spacing { = 'integer ' }"

Parameter	Description
graphname	The name of the graph control in the DataWindow for which you want to get or set the spacing.
integer	(exp) An integer specifying the gap between categories in the graph. You specify the value as a percentage of the width of the data marker. For example, in a bar graph, 100 is the width of one bar, 50 is half a bar, and so on. Integer can be a DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Spacing option.

Examples

string setting
setting = dw1.Object.graph_1.Spacing
dw1.Object.graph_1.Spacing = 120
setting = dw1.Describe("graph_1.Spacing")
dw1.Modify("graph_1.Spacing=120")

Sparse

Description

The names of repeating columns that will be suppressed in the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Sparse

Describe and Modify argument:

"DataWindow.Sparse { = 'list ' }"

Parameter	Description
list	(exp) A tab-separated list of column names to be suppressed. List can be a quoted DataWindow expression.

Create method (include at the end of the DataWindow syntax):

Sparse ( names = "col1~tcol2~tcol3 ...")

Usage

In the painter

Set the value using Rows>Suppress Repeating Values.

Examples

string setting
setting = dw1.Object.DataWindow.Sparse
dw1.Object.DataWindow.Sparse = 'col1~tcol2'
setting = dw1.Describe("DataWindow.Sparse")
dw1.Modify("DataWindow.Sparse='col1~tcol2'")

Storage

Description

The amount of virtual storage in bytes that has been allocated for the DataWindow object.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Storage

Describe argument:

"DataWindow.Storage"

Usage

Canceling a query that uses too much storage

You can check this property in the script for the RetrieveRow event in the DataWindow control and cancel a query if it is consuming too much storage.

Examples

string setting
setting = dw1.Object.DataWindow.Storage
setting = dw1.Describe("DataWindow.Storage")
IF Long(setting) > 50000 THEN RETURN 1

StoragePageSize

Description

The default page size for DataWindow storage.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.StoragePageSize

Describe and Modify argument:

"DataWindow.StoragePageSize { = 'size ' }"

Parameter	Description
size	Two values are provided to enable the DataWindow to use the available virtual memory most efficiently in the current environment: LARGE (Recommended) MEDIUM

Usage

Set this property to avoid out of memory errors when performing large retrieve, import, or RowsCopy operations. The property must be set before the operation is invoked.

Examples

dw1.Modify("datawindow.storagepagesize='LARGE'")
dw1.object.datawindow.storagepagesize='large'

Summary.property

SuppressEventProcessing

Description

Whether the ButtonClicked or ButtonClicking event is fired for this particular button.

Applies to

Button controls

Syntax

PowerBuilder dot notation:

dw_control.Object.buttonname.SuppressEventProcessing

Describe and Modify argument:

"buttonname.SuppressEventProcessing { = ' value ' }"

Parameter

Description

buttonname

The name of the button control for which you want to suppress event processing.

value

Whether event processing is to occur.

Values are:

Yes -- The event should not be fired.

No -- The event should be fired (default).

Usage

In the painter

Select the control and set the value in the Properties view, General tab.

Examples

string setting
dw1.Object.b_name.SuppressEventProcessing = "Yes"
setting = dw1.Describe("b_name.SuppressEventProcessing")
dw1.Modify("b_name.SuppressEventProcessing = 'No'")

Syntax

Description

The complete syntax for the DataWindow.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Syntax

Describe argument:

"DataWindow.Syntax"

Examples

setting = dw1.Object.DataWindow.Syntax
setting = dw1.Describe("DataWindow.Syntax")

Syntax.Data

Description

The data in the DataWindow object described in parse format (the format required by the DataWindow parser).

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Syntax.Data

Describe argument:

"DataWindow.Syntax.Data"

Usage

Use this property with the Syntax property to obtain the description of the DataWindow object and the data. Using this information, you can create a syntax file that represents both the structure and data of a DataWindow at an instant in time. You can then use the syntax file as a DropDownDataWindow containing redefined data at a single location or to mail this as a text object.

Syntax.Modified

Description

Whether the DataWindow syntax has been modified by a function call or user intervention. Calling the Modify, SetSort, or SetFilter method or changing the size of the DataWindow grid automatically sets Syntax.Modified to Yes.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Syntax.Modified

Describe and Modify argument:

"DataWindow.Syntax.Modified { = value }"

Parameter

Description

value

Whether the DataWindow syntax has been modified.

Values are:

Yes -- DataWindow syntax has been modified.
No -- DataWindow has not been modified.

Usage

Use this property in Modify to set Syntax.Modified to No after you cause a change in the syntax that does not affect the user (such as setting preview on).

Examples

string setting
setting = dw1.Object.DataWindow.Syntax.Modified
dw1.Object.DataWindow.Syntax.Modified = "No"
setting = dw1.Describe("DataWindow.Syntax.Modified")
dw1.Modify("DataWindow.Syntax.Modified=No")

Table (for Create)

Description

The section of the DataWindow syntax that specifies information about the DataWindow's database table, including the name of the update table.

Use Table in DataWindow syntax for the Create method.

Syntax

Does not apply.

Usage

Use this property to redefine a DataWindow result set. You can add a column, change the datatype of a column, or make other changes to the table section of your DataWindow involving properties that are not accessible through Modify calls or dot notation.

Caution

When you use this property to redefine the result set, you must redefine the table section in its entirety.

You can call the GetItem and SetItem methods to access columns added using this property, but the columns do not display in the DataWindow unless you call Modify("create column(...)") to add them.

To redefine your table section:

Export your DataWindow object to a DOS file.
Copy only the table section into your script.
Modify the table section to meet your needs.
Put the new table definition into a string variable. Change existing double quotation marks (") in the string to single quotation marks (') and change the tilde quotation marks to tilde tilde single quotation marks (~~').
Call Modify. Modifying the table section of your DataWindow causes the DataWindow to be reset.
(Optionally) Call Modify to add the column to the DataWindow display.

Table (for InkPicture and TableBlobs)

Description

The name of the database table that contains the blob(s).

Applies to

InkPicture and TableBlob controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Table

Describe and Modify argument:

"controlname.Table { = 'tablename ' }"

Parameter	Description
controlname	The name of the control in the DataWindow.
tablename	(exp) A string specifying the name of the table that contains the blob data. Tablename can be a quoted DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Definition tab, Table option. For InkPicture controls, the table contains a large binary column to store ink overlay data and a large binary column to hold a background image for the InkPicture control. For TableBlob controls, the table contains the large binary database object you want to insert into the DataWindow.

Examples

setting = dw1.Object.inkpic_1.Table
dw1.Object.inkpic_1.Table = "inkpictable"
 
setting = dw1.Describe("inkpic_1.Table")
dw1.Modify("inkpic_1.Table='inkpictable'")
 
setting = dw1.Object.blob_1.Table
dw1.Object.blob_1.Table = "emp_pictures"
setting = dw1.Describe("blob_1.Table")
dw1.Modify("blob_1.Table='emp_pictures'")

Table.property

Description

Properties for the DataWindow's DBMS connection.

You can also specify stored procedures for update activities. For information, see Table.sqlaction.property.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Table.property

Describe and Modify argument:

"DataWindow.Table.property { = value }"

Parameter	Description
property	A property for the DataWindow's DBMS connection. Properties and appropriate values are listed in the table below.
value	The value to be assigned to the property.

Property for Table	Value
Arguments	(Read only) A string containing retrieval argument names and types for the DataWindow.
CrosstabData	A string containing a tab-separated list of the expressions used to calculate the values of columns in a crosstab DataWindow.
Data.Storage	A string indicating whether table data is to be kept in memory or offloaded to disk. Values are: Memory (Default) -- Table data is to be kept in memory. Disk -- Table data is to be offloaded to disk. Painter: Rows>Retrieve Options>Rows to Disk.
Delete.Argument	(Internal use only) A string containing arguments to pass to the delete method.
Delete.Method	(Internal use only) The name of the method.
Delete.Type	(Internal use only) Currently stored procedure is the only type implemented.
Filter	(exp) A string containing the filter for the DataWindow. Filters are expressions that can evaluate to true or false. The Table.Filter property filters the data before it is retrieved. To filter data already in the DataWindow's buffers, use the Filter property or the SetFilter and Filter methods. The filter string can be a quoted DataWindow expression. Painter: Rows>Filter.
GridColumns	(Read-only) The grid columns of a DataWindow.
Insert.Argument	(Internal use only) A string containing arguments to pass to the insert method.
Insert.Method	(Internal use only) The name of the method.
Insert.Type	(Internal use only) Currently stored procedure is the only type implemented.
Procedure	A string that contains the number of the result set returned by the stored procedure to populate the DataWindow object. You can use this property only if your DBMS supports stored procedures. Use this property to change the stored procedure or to change the data source from a SELECT statement or script to a stored procedure (see the example). Painter: Set when Stored Procedure is selected as a data source.
Select	A string containing the SQL SELECT statement that is the data source for the DataWindow. Use this property to specify a new SELECT statement or change the data source from a stored procedure or Script to a SELECT statement. Table.Select has several advantages over the SetSqlSelect method: It is faster. PowerBuilder does not validate the statement until retrieval. You can change data source for the DataWindow. For example, you can change from a SELECT to a Stored Procedure. You can use none or any of the arguments defined for the DataWindow object in the SELECT. You cannot use arguments that were not previously defined for the DataWindow object. Describe always tries to return a SQL SELECT statement. If the database is not connected and the property's value is a PBSELECT statement, Describe will convert it to a SQL SELECT statement if a SetTransObject method has been executed. If you are using describeless retrieval (the StaticBind database parameter is set to 1), you cannot use the Select property. Painter: Set when Select or Quick Select is selected as a data source.
Select.Attribute	(Read-only) A string containing the PBSELECT statement for the DataWindow.
Sort	(exp) A string containing the sort criteria for the DataWindow, for example, "1A,2D" (column 1 ascending, column 2 descending). The Table.Sort property sorts the data before it is retrieved. To sort data already in the DataWindow's buffers, use the SetSort and Sort methods. The value for Sort is quoted and can be a DataWindow expression. Painter: Rows>Sort.
SQLSelect	The most recently executed SELECT statement. Setting this has no effect. See Select in this table.
Update.Argument	(Internal use only) A string containing arguments to pass to the update method.
Update.Method	(Internal use only) The name of the method.
Update.Type	(Internal use only) Currently stored procedure is the only type implemented.
UpdateKey InPlace	Whether the key column can be updated in place or the row has to be deleted and reinserted. This value determines the syntax PowerBuilder generates when a user modifies a key field: Yes -- Use the UPDATE statement when the key is changed so that the key is updated in place. No -- Use a DELETE and an INSERT statement when the key is changed. Caution When there are multiple rows in a DataWindow object and the user switches keys or rows, updating in place might fail due to DBMS duplicate restrictions. Painter: Rows>Update Properties, Key Modification.
UpdateTable	A string specifying the name of the database table used to build the Update syntax. Painter: Rows>Update Properties, Table to Update.
UpdateWhere	An integer indicating which columns will be included in the WHERE clause of the Update statement. The value of UpdateWhere can impact performance or cause lost data when more than one user accesses the same tables at the same time. Values are: 0 -- Key columns only (risk of overwriting another user's changes, but fast). 1 -- Key columns and all updatable columns (risk of preventing valid updates; slow because SELECT statement is longer). 2 -- Key and modified columns (allows more valid updates than 1 and is faster, but not as fast as 0). For more about the effects of this setting, see the discussion of the Specify Update Characteristics dialog box in Controlling Updates in DataWindow objects in Users Guide. Painter: Rows>Update Properties, Where Clause for Update/Delete.

Examples

setting = dw1.Object.DataWindow.Table.Sort
dw1.Object.DataWindow.Table.Data.Storage = "disk"
dw1.Object.DataWindow.Table.Filter = "salary>50000"
setting = dw1.Describe("DataWindow.Table.Sort")
dw1.Modify("DataWindow.Table.Filter='salary>50000'")
dw_l.Modify (" DataWindow.Table.Procedure= &
      '1 Execute MyOwner MyProcName;1 &
    @NameOfProcArg=:NameOfDWArg, &
      @NameOfProcArg=:NameOfDWArg...' ")
sqlvar = 'SELECT ... WHERE ...'
dw1.Modify("DataWindow.Table.Select='" + sqlvar + "'")

Table.sqlaction.property

Description

The way data is updated in the database. When the Update method is executed, it can send UPDATE, INSERT, and DELETE SQL statements to the DBMS. You can specify that a stored procedure be used instead of the default SQL statement for each type of data modification.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Table.sqlaction.property

Describe and Modify argument:

"DataWindow.Table.sqlaction.property { = value }"

Parameter

Description

sqlaction

The SQL statement that would ordinarily be executed as part of a database update.

Values are:

UPDATE
INSERT
DELETE

property

A property for sqlaction. Properties and appropriate values are listed in the table below.

value

The value to be assigned to the property.

Property for Table

Value

Arguments

A string specifying the arguments used in the stored procedure. The string takes this format:

("argname", valuetype { =("valuesrc" {, datasrc, paramtype } )

Argname is the name of the stored procedure parameter.

Valuetype is one of the keywords described below. Datasrc and paramtype apply to the COLUMN keyword.

Valuesrc is the column, computed field, or expression that produces the value to be passed to the stored procedure.

Method

A string specifying the name of the stored procedure. The stored procedure is used only if the value of Type is SP.

Type

Specifies whether the database update is performed using a stored procedure.

Values are:

SP -- The update is performed using a stored procedure.
SQL -- The update is performed using standard SQL syntax (default).

Keyword for valuetype	Description
COLUMN	The argument value will be taken from the table and column named in valuesrc. Valuesrc has the form: "tablename.column" For COLUMN, you must also specify whether the data is the new or original column value. Values for datasrc are: NEW The new column value that is being sent to the database. ORIG The value that the DataWindow originally read from the database. You can also specify the type of stored procedure parameter. Values for paramtype are: IN (Default) An input parameter for the procedure. OUT An output parameter for the procedure. The DataWindow will assign the resulting value to the current row and column (usually used for identity and timestamp columns). INOUT An input and output parameter. A sample string for providing a column argument is: ("empid", COLUMN=("employee.empid", ORIG, IN))
COMPUTE	The computed field named in valuesrc is the source of the value passed to the stored procedure. A sample string for providing a computed field argument is: ("newsalary", COMPUTE=("salary_calc"))
EXPRESSION	The expression specified in valuesrc is evaluated and passed to the stored procedure. A sample string for providing an expression argument is: ("dept_name", EXPRESSION=("LookUpDisplay(dept_id)"))
UNUSED	No value is passed to the stored procedure.

Usage

In the painter

Set the values using Rows>Stored Procedure Update. Select the tab page for the SQL command you want to associate with a stored procedure.

In code

If you enable a DataWindow object to use stored procedures to update the database when it is not already using stored procedures, you must change Type to SP first. Setting Type ensures that internal structures are built before you set Method and Arguments. If you do not change Type to SP, then setting Method or Arguments will fail.

When the values you specify in code are nested in a longer string, you must use the appropriate escape characters for quotation marks.

Examples

Each is all on one line:

dw_x.Describe("DataWindow.Table.Delete.Method")
dw_x.Describe("DataWindow.Table.Delete.Arguments")
dw_x.Modify("DataWindow.Table.Delete.Type=SP")
dw_x.Modify("DataWindow.Table.Delete.Arguments = ((~"id~", COLUMN=(~"department.dept_id!~", ORIG)))") 
dw_x.Modify("DataWindow.Table.Delete.Method = ~"spname~"")

TabSequence

Description

The number assigned to the specified control in the DataWindow's tab order.

Applies to

Button, Column, Computed Field, Graph, OLE Object, OLE Database Blob, Picture, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.columnname.TabSequence

Describe and Modify argument:

"columnname.TabSequence { = number }"

Parameter	Description
columnname	The name of the column whose tab order you want to get or set.
number	A number from 0 to 32000 specifying the position of the column in the tab order. A value of 0 takes the column out of the tab order and makes it read-only.

Usage

In the painter

Set the value using Format>Tab Order.

Examples

string setting
setting = dw1.Object.emp_name.TabSequence
dw1.Object.emp_name.TabSequence = 10
setting = dw1.Describe("emp_name.TabSequence")
dw1.Modify("emp_name.TabSequence = 10")

Tag

Description

The tag value of the specified control. The tag value can be any text you see fit to use in your application.

Applies to

Button, Column, Computed Field, Graph, GroupBox, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Tag

Describe and Modify argument:

"controlname.Tag { = ' string ' }"

Parameter	Description
controlname	The name of a control in the DataWindow.
string	(exp) A string specifying the tag for controlname. String is quoted and can be a DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Tag option.

Examples

setting = dw1.Object.blob_1.Tag
dw1.Object.graph_1.Tag = 'Graph of results'
setting = dw1.Describe("blob_1.Tag")
dw1.Modify("graph_1.Tag = 'Graph of results'")

Target

Description

The columns and expressions whose data is transferred from the DataWindow to the OLE object.

Applies to

OLE Object controls

Syntax

PowerBuilder dot notation:

dw_control.Object.oleobjectname.Target

Describe and Modify argument:

"oleobjectname.Target { = ' columnlist ' }"

Parameter	Description
oleobjectname	The name of the OLE Object control for which you want to get or set the data to be transferred.
columnlist	(exp) A list of the columns or expressions whose data is transferred to the OLE object. If there is more than one, separate them with commas. Columnlist can be a quoted DataWindow expression.

Usage

GroupBy and Range also affect the data that is transferred to the OLE object.

In the painter

Select the control and set the value in the Properties view, Data tab, Target Data option.

Examples

setting = dw1.Object.ole_1.Target
dw1.Object.ole_1.Target = 'lname, Len(companyname)'
setting = dw1.Describe("ole_1.Target")
dw1.Modify("ole_1.Target = 'lname, Len(companyname)'")

Template

Description

The name of a file that will be used to start the application in OLE.

Applies to

TableBlob controls

Syntax

PowerBuilder dot notation:

dw_control.Object.tblobname.Template

Describe and Modify argument:

"tblobname.Template { = ' string ' }"

Parameter	Description
tblobname	The name of a TableBlob control in the DataWindow.
string	(exp) A string whose value is the file name of an application that is to be the OLE template. String is quoted and can be a DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, Definition tab, File Template option.

Examples

setting = dw1.Object.blob_1.Template
dw1.Object.blob_1.Template='Excel.xls'
setting = dw1.Describe("blob_1.Template")
dw1.Modify("blob_1.Template='Excel.xls'")

Text

Description

The text of the specified control.

Applies to

Button, GroupBox, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.textname.Text

Describe and Modify argument:

"textname.Text { = ' string ' }"

Parameter	Description
textname	The name of a control in the DataWindow.
string	(exp) A string specifying the text for textname. To specify an accelerator key in the text, include an ampersand before the desired letter. The letter will display underlined. String is quoted and can be a DataWindow expression.

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Text option.

Examples

setting = dw1.Object.text_1.Text
dw1.Object.text_1.Text = "Employee &Name"
setting = dw1.Describe("text_1.Text")
dw1.Modify("text_1.Text='Employee &Name'")

Timer_Interval

Description

The number of milliseconds between the internal timer events. When you use time in a DataWindow, an internal timer event is triggered at the interval specified by Timer_Interval. This determines how often time fields are updated.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.Timer_Interval

Describe and Modify argument:

"DataWindow.Timer_Interval { = number }"

SyntaxFromSql:

DataWindow ( Timer_Interval = number )

Parameter	Description
number	An integer specifying the interval between timer events in milliseconds. The default is 60,000 milliseconds or one minute. The maximum value is 65,535 milliseconds.

Usage

When a computed field uses Now as its expression value, it refreshes the displayed value every time the timer interval period elapses.

In the painter

Select the DataWindow by deselecting all controls; then set the value in the Properties view, General tab, Timer Interval option.

Examples

string setting
setting = dw1.Object.DataWindow.Timer_Interval
dw1.Object.DataWindow.Timer_Interval = 10000
setting = dw1.Describe("DataWindow.Timer_Interval")
dw1.Modify("DataWindow.Timer_Interval=10000")

Title

Description

The title of the graph.

Applies to

Graph controls

Syntax

PowerBuilder dot notation:

dw_control.Object.graphname.Title

Describe and Modify argument:

"graphname.Title { = 'titlestring ' }"

Parameter	Description
graphname	In the DataWindow object, the name of the Graph control for which you want to get or set the title
titlestring	A string specifying the graph's title

Usage

In the painter

Select the control and set the value in the Properties view, General tab, Title option.

The default expression for the Title.DispAttr.DisplayExpression property is "title", which refers to the value of the Title property. The display expression can combine the fixed text of the Title property with other text, functions, and operators. If the expression for Title.DispAttr.DisplayExpression does not include the Title property, then the value of the Title property will be ignored.

For an example, see DispAttr.fontproperty.

Examples

setting = dw1.Object.gr_1.Title
dw1.Object.gr_1.Title = 'Sales Graph'
setting = dw1.Describe("gr_1.Title")
dw1.Modify("gr_1.Title = 'Sales Graph'")

Title.DispAttr.fontproperty

Tooltip.property

Description

Settings for tooltips for a column or control.

Applies to

Button, Column, Computed Field, Graph, GroupBox, InkPicture, Line, OLE, Blob OLE, Oval, Picture, Rectangle, Report, RoundRectangle, and Text controls

Syntax

PowerBuilder dot notation:

dw_control.Object.controlname.Tooltip.property

Describe and Modify argument:

"controlname.Tooltip.property { = 'value ' }"

SyntaxFromSql:

Column ( Tooltip.property = value )
Text ( Tooltip.property = value )

Parameter

Description

controlname

The control whose Tooltip properties you want to get or set.

When generating DataWindow syntax with SyntaxFromSql, the Tooltip settings apply to all columns or all text controls.

property

A property that applies to the tooltip of a control, as listed in the Property table below.

value

Values for the properties are shown below. Value can be a quoted DataWindow expression.

Property for Tooltip	Value
Backcolor	(exp) A long specifying the color (the red, green, and blue values) to be used for the background color of the tooltip box.
Delay.initial	(exp) An integer specifying the time in milliseconds before the tooltip box displays (minimum zero, maximum 32767). Default value is 0.
Delay.visible	(exp) An integer specifying the time in milliseconds that the tootip box remains visible (minimum zero, maximum 32767). Default value is 32000.
Enabled	(exp) Whether the tooltip is enabled. Values are: 1 -- The tooltip is enabled. 0 -- (Default) The tooltip is disabled.
HasCloseButton	Reserved for future use only
Icon	(exp) A string for the icon to display to the left of the title in the tooltip box. The default is for no icon to display. Three stock icons are available for display in the tooltip box: Info, Warning, and Error. 0 -- None 1 -- Info 2 -- Warning 3 -- Error
Isbubble	(exp) Whether the tooltip box displays as a basic rectangle or a callout bubble. Values are: 0 -- Displays the standard tooltip shape. 1 -- Displays the tooltip as a rounded callout bubble.
MaxWidth	Reserved for future use only
Position	Reserved for future use only
Tip	(exp) A string specifying the text for the tooltip. If you use an expression, make sure the result is converted to a string.
Title	(exp) A string specifying the tooltip box title. If you use an expression, make sure the result is converted to a string.
Textcolor	(exp) A long expression specifying the color (the red, green, and blue values) to be used as the control's tooltip color.

Usage

In the painter

Select the control and set the value on the Tooltip tab of the Properties view.

Not available for columns or controls in RichText, Graph, or OLE DataWindow objects. If you want to add a tooltip to an InkPicture in a DataWindow, that InkPicture must not be enabled.

Examples

dw_1.Object.oval_1.Tooltip.Color = RGB(255, 0, 128)
ls_data = dw_1.Describe("oval_1.Tooltip.Color")
dw_1.Modify("emp_name.Tooltip.Color='11665407'")
SQLCA.SyntaxFromSQL(sql_syntax, &
   "Style(...) Column(Tooltip.Delay.Visible=15 ...) &
    ...",    ls_Errors)
SQLCA.SyntaxFromSQL(sql_syntax, &
  "Style(...) Column(Tooltip.TextColor=11665407 ...)"&
  , ls_Errors)

Trail_Footer

Description

Whether the footer of a nested report is displayed at the end of the report or at the bottom of the page. Trail_Footer applies only to reports in a composite DataWindow. Setting Trail_Footer to No forces controls following the report onto a new page.

Applies to

Report controls

Syntax

PowerBuilder dot notation:

dw_control.Object.reportname.Trail_Footer

Describe and Modify argument:

"reportname.Trail_Footer { = value }"

Parameter

Description

reportname

The name of the report control for which you want to get or set Trail_Footer.

value

Whether the report's footer trails the last line of the report or appears at the bottom of the page.

Values are:

Yes -- The footer appears right after the last line of data in the report.

No -- The footer appears at the bottom of the page, forcing any data following the report onto the following page.

Examples

string setting
setting = dw1.Object.rpt_1.Trail_Footer
dw1.Object.rpt_1.Trail_Footer = "Yes"
setting = dw1.Describe("rpt_1.Trail_Footer")
dw1.Modify("rpt_1.Trail_Footer = Yes")

Trailer.#.property