|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ICharacterSeparatedValuesExportFormatOptions
This class is used to set the format options for a report that is to be exported with Separated Values (CSV).
| Nested Class Summary | |
|---|---|
static class |
ICharacterSeparatedValuesExportFormatOptions.ExportMode
This class is used to specify the export mode of a report. |
static class |
ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption
This class is used to specify the export sections options of a report. |
| Method Summary | |
|---|---|
java.lang.String |
getDelimiter()
Gets the delimiter that is used to enclose all non-numeric report fields in the output file. |
ICharacterSeparatedValuesExportFormatOptions.ExportMode |
getExportMode()
Gets the ExportMode of the report. |
ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption |
getGroupSectionsOption()
Gets the group sections option of the report. |
boolean |
getPreserveDateFormatting()
Deprecated. As of version 11.5. The option is always considered true. |
boolean |
getPreserveNumberFormatting()
Deprecated. As of version 11.5. The option is always considered true. |
ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption |
getReportSectionsOption()
Gets the report sections option of the report. |
java.lang.String |
getSeparator()
Gets the character that is used to separate one report field from another in the output file. |
void |
setDelimiter(java.lang.String Delimiter)
Sets the delimiter that is used to enclose all non-numeric report fields in the output file. |
void |
setExportMode(ICharacterSeparatedValuesExportFormatOptions.ExportMode exportMode)
Sets the ExportMode of the report. |
void |
setGroupSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Sets the group sections option of the report. |
void |
setPreserveDateFormatting(boolean bPreserveDateFormatting)
Deprecated. As of version 11.5. The option is always considered true. |
void |
setPreserveNumberFormatting(boolean bPreserveNumberFormatting)
Deprecated. As of version 11.5. The option is always considered true. |
void |
setReportSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Sets the report sections option of the report. |
void |
setSeparator(java.lang.String Separator)
Sets the character that is used to separate one report field from another in the output file. |
| Method Detail |
|---|
void setDelimiter(java.lang.String Delimiter)
Sets the delimiter that is used to enclose all non-numeric report fields in the output file.
When you export a report to a Separated Values (CSV) file, the program encloses all non-numeric fields in quotation marks. The recommended values for this property are either single(') or double (") quotes as they are commonly accepted by applications that can open Separated Values (CSV) files.
Any string can be used for this property but the string must be selected carefully to ensure that the application that reads the output file can do so without confusion.
Delimiter - A String that specifies the delimiter.java.lang.String getDelimiter()
Gets the delimiter that is used to enclose all non-numeric report fields in the output file.
String that specifies the delimiter.void setSeparator(java.lang.String Separator)
Sets the character that is used to separate one report field from another in the output file.
When you export a report to a Separated Values (CSV) file, you must specify the character to be used to separate one field from another in that file. Set this property to any keyboard character.
The recommended value for this property is a comma as it is commonly accepted by applications that can open Separated Value (CSV) files. Avoid specifying quotation marks as a separator, because they are used to surround non-numeric fields.
Separator - A String that specifies the keyboard character that is used as the separator.java.lang.String getSeparator()
Gets the character that is used to separate one report field from another in the output file.
String that specifies the keyboard character that is used as the separator.void setPreserveNumberFormatting(boolean bPreserveNumberFormatting)
true.
Sets whether the number formatting of the report is preserved when the report is exported.
bPreserveNumberFormatting - true if the number formatting of the report is preserved when it is exported, and false otherwise.boolean getPreserveNumberFormatting()
true.
Gets whether the number formatting of the report is preserved when the report is exported.
true if the number formatting of the report is preserved when it is exported, and false otherwise.void setPreserveDateFormatting(boolean bPreserveDateFormatting)
true.
Sets whether the date formatting of the report is preserved when the report is exported.
bPreserveDateFormatting - true if the date formatting of the report is preserved when it is exported, and false otherwise.boolean getPreserveDateFormatting()
true.
Gets whether the date formatting of the report is preserved when the report is exported.
true if the date formatting of the report is preserved when it is exported, and false otherwise.ICharacterSeparatedValuesExportFormatOptions.ExportMode getExportMode()
Gets the ExportMode of the report.
ExportMode of the report.void setExportMode(ICharacterSeparatedValuesExportFormatOptions.ExportMode exportMode)
Sets the ExportMode of the report.
exportMode - the ExportMode of the reportICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getReportSectionsOption()
Gets the report sections option of the report. See
ExportSectionsOption for details.
ExportSectionsOption of the report.void setReportSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Sets the report sections option of the report. See
ExportSectionsOption for details.
exportSectionsOptions - the ExportSectionsOption of the reportICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getGroupSectionsOption()
Gets the group sections option of the report. See
ExportSectionsOption for details.
ExportSectionsOption of the report.void setGroupSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Sets the group sections option of the report. See
ExportSectionsOption for details.
exportSectionsOptions - the ExportSectionsOption of the report
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||