Syntax 4
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 |
Syntax
PowerBuilder
|
1 |
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 |
|
dwbuffer |
A value of the dwBuffer enumerated datatype If |
|
startrow (optional) |
The number of the first detail row in the buffer |
|
endrow (optional) |
The number of the last detail row in the buffer |
|
startcolumn (optional) |
The number of the first column in the buffer that |
|
endcolumn (optional) |
The number of the last column in the buffer that |
|
format (optional) |
A boolean specifying the JSON
See the section called “Supported JSON formats” in Application Techniques for details about the JSON |
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
Usage
The Number data type is handled as Double data type; 15 digits of
precision is supported; and it will be written in scientific notation if
it exceeds 15 digits.
The Decimal{0} data type is handled as Double data type; it has no
fractional part, and the digits in the fractional part (if any) will be
rounded to the integral part; 15 digits of precision is supported; and
it will be written in scientific notation if it exceeds 15
digits.
The Decimal{n} data type is handled as Double data type; it can
have n digits in the fractional part, and the following digits (if any)
will be rounded; 15 digits of precision is supported; and it will be
written in scientific notation if it exceeds 15 digits.
Examples
This example exports data from the delete buffer of the DataWindow
to a plain JSON string:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
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:
|
1 2 |
string ls_DWJson ls_DWJson = dw_1.ExportJson(Primary!, 1, 10, 2, 5, true) |
See also