Functions of DataWindow control

Supported

There are some limitations or differences for calling functions marked with the "*" symbol. Refer to the Limitations and Differences for Calling Functions.

Table 267. 

AcceptText

CategoryCount

CategoryName

ClassName

Clear

ClearValues

ClipBoard

Copy

CopyRTF

Collapse

CollapseAll

CollapseAllChildren

CollapseLevel

Cut

DataCount

DeletedCount

DeleteRow

Describe*

Drag

Expand

ExpandAll

ExpandAllChildren

ExpandLevel

Filter

FilteredCount

Find

FindCategory

FindGroupChange

FindNext

FindSeries

GetBandAtPointer

GetBorderStyle

GetChanges

GetChild

GetClickedColumn

GetClickedRow*

GetColumn

GetColumnName

GetData

GetDataPieExplode

GetDataStyle

GetDataValue

GetFormat

GetFullState*

GetItemDate

GetItemDataTime

GetItemDecimal

GetItemFormattedString

GetItemUnformattedString

GetItemNumber

GetItemStatus

GetItemString

GetItemTime

GetNextModified

GetObjectAtPointer

GetParent

GetRow

GetRowFromRowId

GetSelectedRow

GetSeriesStyle

GetSQLPreview

GetSQLSelect*

GetText

GetValidate

GetValue*

GroupCalc

Hide

ImportClipboard*

ImportFile*

InsertDocument

InsertRow

ImportString*

IsExpanded

IsSelected

LineCount

ModifiedCount

Modify*

ObjectAtPointer

Paste

PasteRTF

Position

PointerX

PointerY

PostEvent

Print*

PrintCancel

Reset*

ResetDataColors

ResetUpdate

Resize

Retrieve*

RowCount

RowsCopy*

RowsDiscard

RowsMove

SaveAs*

SaveAsAscii

ScrollNextPage

ScrollNextRow

ScrollPriorPage

ScrollPriorRow

ScrollToRow

SelectedLength

SelectedStart

SelectedText

SelectedLine

SelectRow

SelectText

SelectTextLine

SelectTextAll*

SelectTextWors

SetChanges

SeriesCount

SeriesName

SetBorderStyle

SetColumn

SetDataPieExplode

SetDataStyle

SetDetailHeight*

SetFilter

SetFocus

SetFormat

SetFullState

SetItem

SetItemStatus

SetPosition*

SetRedraw

SetRow

SetRowFocusIndicator

SetSeriesStyle

SetSort*

SetSQLPreview

SetSQLSelect*

SetTabOrder

SetText

SetTransObject

SetValidate

SetValue*

SetWSObject*

ShareData

ShowHeadFoot

ShareDataOff

Show

Sort*

TextLine

TriggerEvent*

Typeof

Undo

Update

 

Unsupported

Table 268. 

CanUnDo

CrosstabDialog

DBCancel

DBErrorCode

DBErrorMessage

ExportJson

GenerateHTMLForm

GenerateResultSet

GetContextService

GetMessageText

GetStateStatus

GetTrans

GetUpdateStatus

ImportJson

ImportJsonByKey

OLEActivate

ResetInk

ReselectRow

SaveAsFormattedText

SaveInk

SaveInkPic

SaveNativePDFToBlob

Scroll

ResetTransObject

SetActionCode

SetHTMLAction

SetTrans


Limitations and Differences for Calling Functions

1. Limitations

  • GetFullState

    The Retrieve argument is unsupported in the GetFullState function.

  • GetSQLSelect

    If the syntax in DataWindow is PBSELECT statement, when calling the GetSQLSelect function, it will still return the PBSELECT statement but not the SQL SELECT statement, which is different from that in PowerBuilder.

  • GetValue

    The column argument only works when the edit style of the column is CheckBox, DropDownListBox, Edit, or RadioButton.

  • ImportFile, ImportString, ImportClipboard

    1. The filename argument of ImportFile function must be a tab-separated file (TXT) or a comma-separated file (CSV).

    2. The importtype arguments (e.g. Text!, CSV! and XML!) of ImportString function are unsupported.

      The importtype arguments (e.g. Text!, CSV!, XML!, DBase2!, DBase3!) of ImportFile function are unsupported.

    3. When using these functions, you should ensure that the data type imported matches the data type that you specified in a DataWindow control, DataStore object or graph control. Otherwise the output on the Web may be different from that in PowerBuilder. For example, if the date type specified in a DataWindow is string, when you import a file with date number (e.g., 2006-08-01), on the Web the date data will be recognized as a string (2006), however in PowerBuilder, it will be recognized as a date data (2006-08-01).

  • Modify

    If the Modify function is used to modify the WHERE clause of the DataWindow object's SQL SELECT statement, please make sure that the new SQL SELECT statement is correct in syntax. Otherwise, syntax errors can occur because PowerBuilder does not validate the statement whereas JavaScript does.

    When executing Modify function to change the dddw.property on the Web, properties must be separated with spaces when they are concatenated into one value. For example,

    Unsupported code:

    dw_1.Modify = "emp_id.BackGround.Color=" + String(RGB(192,192,192)) + "emp_id.Protect=1"

    Supported code:

    dw_1.Modify = "emp_id.BackGround.Color=" + String(RGB(192,192,192)) + " emp_id.Protect=1"

    For more, refer to Dynamic DataWindow.

  • Print

    1. Arguments specified in the Print function will be ignored in a Web application. Even if theCancelDialog argument is set to TRUE or FALSE, no Cancel dialog will be displayed on the Web to cancel printing.

    2. When the Print function is executed for a DataWindow that contains a Text control with BorderType as None and actual length of the content larger than the length of the control, the printing result shows the content in the Text control the same way as the control is displayed in the application, although in PowerBuilder, the printing result shows the full content in the Text control.

    3. For controls, print function is only supported when called in Graph controls with the following syntax.

      integer objectname.print (long printjobnumber, integer x, integer y{, integer width, integer height})
  • Reset

    The unsupported syntax: Reset(dwcontrol).

    The supported syntax: dwcontrol.Reset.

  • SaveAs

    1. On the Web, Nillable attribute is unsupported in an XML schema.

    2. The supported SaveAs syntax :

      ll_testvalue = dw_test.SaveAs(filename, saveastype, colheading, encoding)

      In the syntax:

      The value of a saveastype argument can be TEXT, HTMLTable, XML, PDF*, EXCEL, or EXCEL5. For the EXCEL format, only up to 256 characters are supported and anything larger will be automatically truncated.

      When saveastype is PDF, the colheading argument is unsupported, for example, the following syntax is unsupported:

      Integer dwcontrol.SaveAs({string filename, saveastype saveastype, boolean colheading{, encoding encoding}})

      The unsupported SaveAs syntax:

      dw_test.SaveAs([filename, ]graphcontrol[, saveastype, colheading])
    3. If the DataWindow without any data is saved as an HTML file or XML file, on Web the DataWindow header will not be saved, whereas it will be saved on PB.

    4. The generated file is automatically saved to the "plugin" folder under the current application directory. See "plugin" folder in Workarounds & APIs Guide for more.

  • SetPosition

    The supported syntax:

    dwcontrol.SetPosition (position {, precedingobject})

    The position can be ToTop! and ToBottom!, but cannot be Behind!

    The unsupported syntax:

    dwcontrol.SetPosition(objectname, band, bringtofront)
  • SetSQLSelect

    If a DataWindow uses a stored procedure as its data source, the SetSQLSelect function cannot be executed for the DataWindow.

  • SetValue

    The SetValue column argument only works if the edit style of the column is DropDownListBox.

  • SetSort

    1. If the Format argument of the SetSort contains sorting criteria for more than one column, the criteria of the columns must be separated with commas.

    2. Using desc or asc as the Order will not have any effect. Please use the standard Order value A for ascending or D for descending order.

  • SetWSObject

    The SetWSObject function is used to set the authentication info for accessing Web service.

  • TriggerEvent

    The following TriggerEvent syntax is unsupported:

    object1.TriggerEvent (object2, event)

2. Differences

  • Describe

    If there is no value for a property in the propertylist argument, Describe returns a question mark (?) in PowerBuilder, but returns the default value (for example, Arrow!) of the property on the Web.

  • GetClickedRow

    In a Web application, if the user clicks or double-clicks any area within a DataWindow, the GetClickedRow function returns the same value as in PowerBuilder. If the GetClickedRow is called in some control or window for a DataWindow, the return value is different on the Web than in PowerBuilder. For example, if the dw_1.GetClickedRow() function is called in the Clicked event of a CommandButton, it returns -1 in PowerBuilder and 0 on the Web.

  • GetItemDecimal

    The return value of the GetItemDecimal function will omit the zero(s) to the right of the decimal value on the Web. For example: 3000.100 will be returned as 3000.1 on the Web but 3000.100 in PowerBuilder.

  • Retrieve

    1. Because Appeon Web applications cannot check whether the retrieve result set matches the DataWindow definition syntax, the DBError event will not be triggered.

    2. If the data type of an EditMask control is numeric, the value of the control cannot be set to "0".

  • SetDetailHight

    Setting detail.height.autosize to true after specifying the height by this function, executing Describe returns the auto sized height on the Web. But in PowerBuilder it returns the height specified by this function.

  • RowDiscard

    For Composite, Group, Label and RichText DataWindows, if the current row is the start row, calling RowDiscard will not trigger RowFocusChanged on the Web. This is different from that in PowerBuilder.

  • SaveAsAscii

    When executing the SaveAsAscii function in PowerBuilder, invisible controls which lay in rows will not be saved as empty rows or " " (quotation marks). However, these invisible controls will be ignored on the Web.

  • SelectTextAll

    If the focus is in the header or footer band, executing SelectTextAll (detail!) on the Web returns -1 and no text will be selected. However, in PowerBuilder, the text in the band, which the focus is in, will be selected.

  • ShareData and ShareDataOff

    1. Supported:

      CONNECT USING SQLCA;
      dw_corp.SetTransObject(SQLCA)
      dw_corp.Retrieve()
      dw_corp.ShareData(dw_emp)
      dw_corp.ShareData(dw_dept)
      ... // Some processing
      dw_emp.ShareDataOff()
      
    2. In Web applications, if any data in two data-sharing Group DataWindows are changed, the primary Group DataWindow will be re-grouped and re-sorted automatically, while the secondary Group DataWindow will only be re-grouped.

    3. The row and column status is shared between the primary DataWindow and secondary DataWindow on the Web, although not shared in PowerBuilder.

  • Sort

    1. Different from the Sort in PowerBuilder, the Web Sort function considers the "~" symbol to have precedence over characters. For this reason, the sort result may be a little different in Web and PowerBuilder applications.

    2. In the Web application, when the user sorts a DataWindow on a specified column, rows containing special characters (e.g. ".", "", "/") will be sorted in different order than in PowerBuilder.