|
XTable
|
Puts the output manager in a state where it is ready to append multiple reports of a specified format. The Open call is usually followed by one or more AppendTable or AppendLine calls and finally a Close.
The results of composing multiple reports can be delivered in two ways. (1) If the the dest parameter is specified then the formatted report is placed into a file with that name in the current job's home folder, which must have been previously set. The return string is the full name of the file. (2) If that dest parameter is null then the formatted report is return as a string and no file is written.
All output formats can be delivered as either a named file, or as a string representation. Although an XLSX can be returned as a bae64 encoded string, that feature is currently disabled.
Namespace: RCS.Carbon.Tables
Assembly: RCS.Carbon.Tables (in RCS.Carbon.Tables.dll) Version: 9.1.0
Syntaxpublic void Open( XDisplayProperties dprops, string dest = null )
Parameters
- dprops XDisplayProperties
[Missing <param name="dprops"/> documentation for "M:RCS.Carbon.Tables.XTableOutputManager.Open(RCS.Carbon.Shared.XDisplayProperties,System.String)"]
- dest String (Optional)
The optional name of a file to receive the generated output. When a value is specified, the currently open job must have a home directory set. Local jobs use the job's home folder as the home directory. Cloud jobs do not have a default home directory and one must be set by calling SetHomeDir previous to this method.
If the value does not have a file extension, then the correct one for the output format will be silently appended. So for example, if the output format is CSV and the parameter value is 'report3' then the name 'report3.csv' will be used for the output file.
Exceptions| Exception | Condition |
|---|---|
| CarbonException | Thrown if the fmt is not supported for this multi-report feature, or if dest is specified and no job home directory has been set. |
See Also