Exports data from the DataWindow control, DataStore object, or DataWindowChild object to the JSON string. The exported JSON string will be a two-level plain JSON string or DataWindow JSON string. For more about the JSON formats, see the section called “Supported JSON formats” in Application Techniques.
Description
Exports data from the DataWindow primary buffer to a plain JSON string or DataWindow JSON string.
Applies to
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, and DataStore object, except for those with the Composite, Crosstab, OLE 2.0, or RichText presentation styles. |
Syntax
PowerBuilder
string dwcontrol.ExportJson( {boolean format} )
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control, DataStore, or DataWindowChild. |
|
format (optional) |
A boolean specifying the JSON format.
See the section called “Supported JSON formats” in Application Techniques for details about the JSON format. |
Return value
String. Returns the JSON string if it succeeds. Returns the empty string ("") if an error occurs.
The method returns null if any of the following:
-
any argument's value is null
-
the DataWindow object (dataobject) is invalid
-
the DataWindow presentation style is unsupported, such as Composite, Crosstab, OLE 2.0, or RichText
Examples
This example exports data from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson()
This example exports data from the primary buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(true)
See also
Description
Exports all rows or only the changed rows from all or specified buffers to a plain JSON string or DataWindow JSON string.
Applies to
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, and DataStore object, except for those with the Composite, Crosstab, OLE 2.0, or RichText presentation styles. |
Syntax
PowerBuilder
string dwcontrol.ExportJson( {DWBuffer dwbuffer,} boolean changedonly, boolean format )
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control, DataStore, or DataWindowChild. |
|
dwbuffer (optional) |
A value of the dwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data. For a list of valid values, see DWBuffer. If not specified, all of the DataWindow buffers will be exported, however, the data for DataWindowChild will not be exported (even if changedonly is false). |
|
changedonly |
A boolean specifying the changing flag.
|
|
format |
A boolean specifying the JSON format.
See the section called “Supported JSON formats” in Application Techniques for details about the JSON format. |
Return value
String. Returns the JSON string if it succeeds. Returns the empty string ("") if an error occurs.
The method returns null if any of the following:
-
any argument's value is null
-
the DataWindow object (dataobject) is invalid
-
the DataWindow presentation style is unsupported, such as Composite, Crosstab, OLE 2.0, or RichText
Examples
This example exports the changed rows from all buffers of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(true, true)
This example exports the changed rows from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Primary!, true, false)
See also
Description
Exports data from the specified buffer(s) and/or DataWindowChild to a plain JSON string or DataWindow JSON string.
Applies to
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, and DataStore object, except for those with the Composite, Crosstab, OLE 2.0, or RichText presentation styles. |
Syntax
PowerBuilder
string dwcontrol.ExportJson( boolean primarydata, boolean filterdata, boolean deletedata, boolean dwcdata {, boolean format} )
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control, DataStore, or DataWindowChild. |
|
primarydata |
A boolean specifying whether to export the data from the primary buffer.
|
|
filterdata |
A boolean specifying whether to export the data from the filter buffer.
|
|
deletedata |
A boolean specifying whether to export the data from the delete buffer.
|
|
dwcdata |
A boolean specifying whether to export the DataWindowChild data.
|
|
format (optional) |
A boolean specifying the JSON format.
See the section called “Supported JSON formats” in Application Techniques for details about the JSON format. |
Return value
String. Returns the JSON string if it succeeds. Returns the empty string ("") if an error occurs.
The method returns null if any of the following:
-
any argument's value is null
-
the DataWindow object (dataobject) is invalid
-
the DataWindow presentation style is unsupported, such as Composite, Crosstab, OLE 2.0, or RichText
Examples
This example exports the data from the primary buffer and the filter buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(true, true, false, false)
This example exports the data from every buffer of the DataWindow and the DataWindowChild to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(true, true, true, true, true)
See also
Description
Exports all data or the specified rows and/or columns from the specified buffer to a plain JSON string or DataWindow JSON string.
Applies to
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, and DataStore object, except for those with the Composite, Crosstab, OLE 2.0, or RichText presentation styles. |
Syntax
PowerBuilder
string dwcontrol.ExportJson( DWBuffer dwbuffer {, long startrow {, long endrow {, long startcolumn {, long endcolumn } } } } {, boolean format } )
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control, DataStore, or DataWindowChild. |
|
dwbuffer |
A value of the dwBuffer enumerated datatype identifying the DataWindow buffer from which you want to export the data. For a list of valid values, see DWBuffer. If not specified, all of the DataWindow buffers will be exported, however, the data for DataWindowChild will not be exported (even if changedonly is false). |
|
startrow (optional) |
The number of the first detail row in the buffer that you want to export. The default is 1. If it is 0 or negative, 1 is used. |
|
endrow (optional) |
The number of the last detail row in the buffer that you want to export. The default is the rest of the rows. If it is 0 or negative, it indicates the rest of rows. |
|
startcolumn (optional) |
The number of the first column in the buffer that you want to export. The default is 1. If it is 0 or negative, 1 is used. |
|
endcolumn (optional) |
The number of the last column in the buffer that you want to export. The default is the rest of the columns. If it is 0 or negative, it indicates the rest of columns. |
|
format (optional) |
A boolean specifying the JSON format.
See the section called “Supported JSON formats” in Application Techniques for details about the JSON format. |
Return value
String. Returns the JSON string if it succeeds. Returns the empty string ("") if an error occurs.
The method returns null if any of the following:
-
any argument's value is null
-
the DataWindow object (dataobject) is invalid
-
the DataWindow presentation style is unsupported, such as Composite, Crosstab, OLE 2.0, or RichText
Examples
This example exports data from the delete buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Delete!)
This example exports data from the filter buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(Filter!, true)
This example exports data in rows 2 through the end from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Primary!, 2)
This example exports data in rows 2 through the end from the primary buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(Primary!, 2, true)
This example exports data in rows 1 through 10 from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Primary!, 1, 10)
This example exports data in rows 1 through 10 from the primary buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(Primary!, 1, 10, true)
This example exports data in rows 1 through 10 and columns 2 through the end from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Primary!, 1, 10, 2)
This example exports data in rows 1 through 10 and columns 2 through the end from the primary buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(Primary!, 1, 10, 2, true)
This example exports data in rows 1 through 10 and columns 2 through 5 from the primary buffer of the DataWindow to a plain JSON string:
string ls_PlainJson ls_PlainJson = dw_1.ExportJson(Primary!, 1, 10, 2, 5)
This example exports data in rows 1 through 10 and columns 2 through 5 from the primary buffer of the DataWindow to a DataWindow JSON string:
string ls_DWJson ls_DWJson = dw_1.ExportJson(Primary!, 1, 10, 2, 5, true)
See also
