[]
        
首页
开发者学堂
文档
论坛
市场
生态机会
活动
立即试用
(Showing Draft Content)

CsvSaveOptions

Class CsvSaveOptions

java.lang.Object
com.grapecity.documents.excel.SaveOptionsBase
com.grapecity.documents.excel.CsvSaveOptions

public class CsvSaveOptions extends SaveOptionsBase
表示将工作簿保存为 CSV 文件的选项。

使用此类可以配置 CSV 导出设置,例如列、行和单元格分隔符、文本编码、值加引号,以及是否裁剪前导空白行和列。保存 CSV 内容时,可以将此类的实例传递给 Workbook.save(String,SaveOptionsBase)。


 worksheet.getRange("A1:B2").setValue(new Object[][] {
     {"Name", "Value"},
     {"Test", 100}
 });
 CsvSaveOptions options = new CsvSaveOptions();
 options.setColumnSeparator(";");
 options.setRowSeparator("\r\n");
 options.setCellSeparator('"');
 options.setValueQuoteType(ValueQuoteType.Always);
 workbook.save("path/to/output.csv", options);
 
  • Constructor Details

    • CsvSaveOptions

      public CsvSaveOptions()
      创建用于将工作簿保存为 CSV 文件的选项。

      此构造函数初始化选项对象以使用 SaveFileFormat.Csv。将选项传递给工作簿保存 API 前,请配置 CSV 特定设置。

      
       worksheet.getRange("A1:B2").setValue(new Object[][] {
           {"Name", "Value"},
           {"Test", 100}
       });
       CsvSaveOptions options = new CsvSaveOptions();
       options.setColumnSeparator(";");
       options.setRowSeparator("\r\n");
       options.setCellSeparator('"');
       options.setValueQuoteType(ValueQuoteType.Always);
       workbook.save("path/to/output.csv", options);
       
  • Method Details

    • getColumnSeparator

      public final String getColumnSeparator()
      获取保存 CSV 数据时使用的列分隔符。

      列分隔符决定导出的 CSV 内容中列之间的值如何分隔。使用 setColumnSeparator(String) 可在保存前更改分隔符。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setColumnSeparator(";");
       String separator = options.getColumnSeparator();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      当前列分隔符字符串。
    • setColumnSeparator

      public final void setColumnSeparator(String value)
      设置保存 CSV 数据时使用的列分隔符。
      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setColumnSeparator(";");
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 当前列分隔符字符串。
    • getRowSeparator

      public final String getRowSeparator()
      获取行分隔符。

      返回将工作簿保存为 CSV 文件时用于分隔行的字符串。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setRowSeparator("\r\n");
       String separator = options.getRowSeparator();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      行分隔符字符串。
    • setRowSeparator

      public final void setRowSeparator(String value)
      设置行分隔符。

      设置将工作簿保存为 CSV 文件时用于分隔行的字符串。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setRowSeparator("\r\n");
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 行分隔符字符串。
    • getCellSeparator

      public final char getCellSeparator()
      获取保存 CSV 内容时使用的单元格分隔符字符。

      此字符用于在导出的 CSV 数据中括起单元格文本。默认值为 '\"'。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setCellSeparator('\'');
       char cellSeparator = options.getCellSeparator();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      用于 CSV 导出的单元格分隔符字符。
    • setCellSeparator

      public final void setCellSeparator(char value)
      设置保存 CSV 内容时使用的单元格分隔符字符。

      此字符用于在导出的 CSV 数据中括起单元格文本。默认值为 '\"'。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setCellSeparator('\'');
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 用于 CSV 导出的单元格分隔符字符。
    • setSeparatorString

      @Deprecated public final void setSeparatorString(String value)
      Deprecated.
      设置列分隔符字符串。

      此方法已弃用,并设置与 getColumnSeparator() 相同的值。默认情况下,分隔符为逗号。

      Parameters:
      value - 列分隔符字符串。
    • getSeparatorString

      @Deprecated public final String getSeparatorString()
      Deprecated.
      获取列分隔符字符串。

      此方法已弃用,并返回与 getColumnSeparator() 相同的值。默认情况下,分隔符为逗号。

      Returns:
      列分隔符字符串。
    • getEncoding

      public final String getEncoding()
      获取保存 CSV 文件时使用的默认编码。

      默认编码为 utf-8。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setEncoding("UTF-16");
       String encoding = options.getEncoding();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      默认编码名称。
    • setEncoding

      public final void setEncoding(String value)
      设置保存 CSV 文件时使用的默认编码。

      默认编码为 utf-8。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setEncoding("UTF-16");
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 默认编码名称。
    • getValueQuoteType

      public final ValueQuoteType getValueQuoteType()
      获取导出的文本文件中值的加引号方式。

      此选项控制保存 CSV 内容时使用的加引号行为。如果设置了 getQuoteColumns(),则忽略此设置。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setValueQuoteType(ValueQuoteType.Always);
       ValueQuoteType quoteType = options.getValueQuoteType();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      导出的文本文件的值加引号模式。
    • setValueQuoteType

      public final void setValueQuoteType(ValueQuoteType value)
      设置导出的文本文件中值的加引号方式。

      使用此属性可以控制 CSV 导出的加引号行为,例如为所有值加引号、仅为包含特殊字符的值加引号,或不为值加引号。如果设置了 getQuoteColumns(),则导出期间会忽略此设置。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setValueQuoteType(ValueQuoteType.Normal);
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 要应用的值加引号模式。如果设置了 getQuoteColumns(),则在 CSV 导出期间忽略此值。未指定 null 行为。
    • getTrimLeadingBlankRowAndColumn

      public final boolean getTrimLeadingBlankRowAndColumn()
      获取保存为 CSV 时是否裁剪前导空白行和列。

      此属性指示 CSV 导出期间是否像 Microsoft Excel 一样裁剪前导空白行和列。默认值为 true。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setTrimLeadingBlankRowAndColumn(false);
       boolean trim = options.getTrimLeadingBlankRowAndColumn();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      如果在 CSV 导出期间裁剪前导空白行和列,则为 true;否则为false。
    • setTrimLeadingBlankRowAndColumn

      public final void setTrimLeadingBlankRowAndColumn(boolean value)
      设置保存为 CSV 时是否裁剪前导空白行和列。

      此属性指示 CSV 导出期间是否像 Microsoft Excel 一样裁剪前导空白行和列。默认值为 true。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setTrimLeadingBlankRowAndColumn(false);
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 如果在 CSV 导出期间裁剪前导空白行和列,则为 true;否则为false。
    • getEscapeFormulaLikeValues

      public final boolean getEscapeFormulaLikeValues()
      获取在导出 CSV 时是否转义以类似公式的字符开头的值。

      如果此属性设置为 true,则以 =、+、-、@、其全角变体、制表符、回车符或换行符开头的值将写入前导单引号。默认值为 false。

      示例:

      。
      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setEscapeFormulaLikeValues(true);
       boolean escape = options.getEscapeFormulaLikeValues();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      如果在导出时转义类似公式的 CSV 值,则为 true;否则为 false。
    • setEscapeFormulaLikeValues

      public final void setEscapeFormulaLikeValues(boolean value)
      设置在导出 CSV 时是否转义以类似公式的字符开头的值。

      如果此属性设置为 true,则以 =、+、-、@、其全角变体、制表符、回车符或换行符开头的值将写入前导单引号。默认值为 false。

      示例:

      。
      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setEscapeFormulaLikeValues(true);
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 如果在导出时转义类似公式的 CSV 值,则为 true;否则为 false。
    • setQuoteColumns

      public final void setQuoteColumns(int[] value)
      设置配置为在 CSV 导出期间加引号的从零开始的列索引。
      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setQuoteColumns(new int[] { 1, 3, 4 });
       workbook.save("path/to/output.csv", options);
       
      Parameters:
      value - 要加引号的从零开始的列索引数组;如果未配置特定列,则为 null。
    • getQuoteColumns

      public final int[] getQuoteColumns()
      获取配置为在 CSV 导出期间加引号的从零开始的列索引。

      使用 setQuoteColumns(int[]) 时,只有指定的列会被强制使用单元格分隔符作为引号,而其他列只有在 CSV 内容要求时才会加引号。无效的列索引会保留在此数组中,但在导出期间不起作用。

      
       CsvSaveOptions options = new CsvSaveOptions();
       options.setQuoteColumns(new int[] { 1, 3, 4 });
       int[] quoteColumns = options.getQuoteColumns();
       workbook.save("path/to/output.csv", options);
       
      Returns:
      要加引号的从零开始的列索引数组;如果未配置特定列,则为 null。
    • toString

      public String toString()
      Returns a string representation of these CSV save options.
      Overrides:
      toString in class Object
      Returns:
      A string representation of these CSV save options.