XlsxSaveOptions

Class XlsxSaveOptions

java.lang.Object

com.grapecity.documents.excel.SaveOptionsBase

com.grapecity.documents.excel.XlsxSaveOptions

Direct Known Subclasses:: XlsmSaveOptions, XltxSaveOptions

public class XlsxSaveOptions extends SaveOptionsBase

表示用于将工作簿另存为 .xlsx 文件的选项。

使用此类控制 GcExcel 如何将工作簿内容导出为 XLSX 格式。它支持密码保护、共享公式导出、紧凑模式、公式处理、绑定源导出、自动合并单元格以及排除未使用样式、名称或空区域单元格以减小文件大小等设置。


 XlsxSaveOptions options = new XlsxSaveOptions();
 String password = getWorkbookPassword();
 options.setPassword(password);
 options.setExcludeUnusedStyles(true);
 options.setExportSharedFormula(false);
 workbook.save("path/to/output.xlsx", options);

Constructor Summary

Constructors

Constructor

Description

XlsxSaveOptions()

创建 XlsxSaveOptions 的新实例。
Method Summary

Modifier and Type

Method

Description

final boolean

getExcludeEmptyRegionCells()

获取保存工作簿时是否排除已用数据区域之外的空单元格。

final boolean

getExcludeUnusedNames()

获取将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的定义名称。

final boolean

getExcludeUnusedStyles()

获取将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的单元格样式。

boolean

getExportSharedFormula()

获取保存工作簿时是否导出共享公式。

final boolean

getIgnoreFormulas()

获取保存为 .xlsx 文件时是否将公式单元格视为值单元格。

final boolean

getIncludeAutoMergedCells()

获取将工作簿保存为 .xlsx 文件时是否包含自动合并的单元格。

final boolean

getIncludeBindingSource()

获取保存文件时是否包含绑定源。

final boolean

getIsCompactMode()

获取是否以紧凑模式保存工作簿。

final String

getPassword()

获取用于加密所保存 xlsx 文件的密码。

final void

setExcludeEmptyRegionCells(boolean value)

设置保存工作簿时是否排除已用数据区域之外的空单元格。

final void

setExcludeUnusedNames(boolean value)

设置将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的定义名称。

final void

setExcludeUnusedStyles(boolean value)

设置将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的单元格样式。

void

setExportSharedFormula(boolean value)

设置保存工作簿时是否导出共享公式。

final void

setIgnoreFormulas(boolean value)

设置保存为 .xlsx 文件时是否将公式单元格视为值单元格。

final void

setIncludeAutoMergedCells(boolean value)

设置将工作簿保存为 .xlsx 文件时是否包含自动合并的单元格。

final void

setIncludeBindingSource(boolean value)

设置保存文件时是否包含绑定源。

final void

setIsCompactMode(boolean value)

设置是否以紧凑模式保存工作簿。

final void

setPassword(String value)

设置用于加密所保存 xlsx 文件的密码。

String

toString()

Returns a string representation of these XLSX save options.

Methods inherited from class com.grapecity.documents.excel.SaveOptionsBase
getFileFormat, setFileFormat

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

XlsxSaveOptions

public XlsxSaveOptions()

创建 XlsxSaveOptions 的新实例。

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


 XlsxSaveOptions options = new XlsxSaveOptions();
 String password = getWorkbookPassword();
 options.setPassword(password);
 options.setExcludeUnusedStyles(true);
 options.setExportSharedFormula(false);
 workbook.save("path/to/output.xlsx", options);

Method Details
- getExportSharedFormula
  
  public boolean getExportSharedFormula()
  获取保存工作簿时是否导出共享公式。
  默认启用共享公式导出。处理不支持共享公式的第三方库时，此选项可能很有用。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExportSharedFormula(false); boolean exportSharedFormula = options.getExportSharedFormula(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果保存工作簿时导出共享公式，则为 true；否则为 false。默认值为 true。
- setExportSharedFormula
  
  public void setExportSharedFormula(boolean value)
  设置保存工作簿时是否导出共享公式。
  默认启用共享公式导出。处理不支持共享公式的第三方库时，此选项可能很有用。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExportSharedFormula(false); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果保存工作簿时导出共享公式，则为 true；否则为 false。默认值为 true。
- getPassword
  
  public final String getPassword()
  获取用于加密所保存 xlsx 文件的密码。
  在使用密码保护保存工作簿之前，使用此方法检索在此 XlsxSaveOptions实例上配置的密码。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); String configuredPassword = getWorkbookPassword(); options.setPassword(configuredPassword); String password = options.getPassword(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  用于加密所保存 xlsx 文件的密码；如果未设置密码，则返回 null。
- setPassword
  
  public final void setPassword(String value)
  设置用于加密所保存 xlsx 文件的密码。
  在使用密码保护保存工作簿之前，使用此方法可设置此 XlsxSaveOptions 实例上的密码。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); String password = getWorkbookPassword(); options.setPassword(password); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 用于加密所保存 xlsx 文件的密码；如果未设置密码，则为 null。
- getIsCompactMode
  
  public final boolean getIsCompactMode()
  获取是否以紧凑模式保存工作簿。
  当此选项为 true 时，生成的 .xlsx 内容会以更紧凑的形式写入。例如，导出时可以省略连续行和列的显式行引用和单元格引用。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIsCompactMode(true); boolean compactMode = options.getIsCompactMode(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果工作簿以紧凑模式保存，则返回 true；否则返回 false。默认值为 false。
- setIsCompactMode
  
  public final void setIsCompactMode(boolean value)
  设置是否以紧凑模式保存工作簿。
  当此选项为 true 时，生成的 .xlsx 内容会以更紧凑的形式写入。例如，导出时可以省略连续行和列的显式行引用和单元格引用。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIsCompactMode(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果工作簿以紧凑模式保存，则为 true；否则为 false。默认值为 false。
- getIgnoreFormulas
  
  public final boolean getIgnoreFormulas()
  获取保存为 .xlsx 文件时是否将公式单元格视为值单元格。
  当此属性为 true 时，公式单元格会在 Excel 中导出为值单元格，而不是保留其公式。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIgnoreFormulas(true); boolean ignoreFormulas = options.getIgnoreFormulas(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果保存时公式单元格导出为值单元格，则返回 true；否则返回 false。
- setIgnoreFormulas
  
  public final void setIgnoreFormulas(boolean value)
  设置保存为 .xlsx 文件时是否将公式单元格视为值单元格。
  当此属性为 true 时，公式单元格会在 Excel 中导出为值单元格，而不是保留其公式。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIgnoreFormulas(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果保存时公式单元格导出为值单元格，则为 true；否则为 false。
- getExcludeUnusedStyles
  
  public final boolean getExcludeUnusedStyles()
  获取将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的单元格样式。
  如果此属性为 true，则导出时会省略工作簿中从未应用的用户定义单元格样式。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeUnusedStyles(true); boolean excludeUnusedStyles = options.getExcludeUnusedStyles(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果 XLSX 导出期间排除未使用的用户定义单元格样式，则返回 true；否则返回 false。
- setExcludeUnusedStyles
  
  public final void setExcludeUnusedStyles(boolean value)
  设置将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的单元格样式。
  如果此属性为 true，则导出时会省略工作簿中从未应用的用户定义单元格样式。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeUnusedStyles(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果 XLSX 导出期间排除未使用的用户定义单元格样式，则为 true；否则为 false。
- getExcludeUnusedNames
  
  public final boolean getExcludeUnusedNames()
  获取将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的定义名称。
  如果此属性为 true，则导出时会省略未使用的定义名称。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeUnusedNames(true); boolean excludeUnusedNames = options.getExcludeUnusedNames(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果 XLSX 导出期间排除未使用的定义名称，则返回 true；否则返回 false。
- setExcludeUnusedNames
  
  public final void setExcludeUnusedNames(boolean value)
  设置将工作簿保存为 XLSX 文件时是否排除用户定义但未使用的定义名称。
  如果此属性为 true，则导出时会省略未使用的定义名称。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeUnusedNames(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果 XLSX 导出期间排除未使用的定义名称，则为 true；否则为 false。
- getExcludeEmptyRegionCells
  
  public final boolean getExcludeEmptyRegionCells()
  获取保存工作簿时是否排除已用数据区域之外的空单元格。
  此上下文中的空单元格是指不包含数据或仅包含样式信息的单元格。当此选项为 true 时，保存期间会排除这些单元格。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeEmptyRegionCells(true); boolean excludeEmptyRegionCells = options.getExcludeEmptyRegionCells(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果保存工作簿时排除已用数据区域之外的空单元格，则返回 true；否则返回 false。
- setExcludeEmptyRegionCells
  
  public final void setExcludeEmptyRegionCells(boolean value)
  设置保存工作簿时是否排除已用数据区域之外的空单元格。
  此上下文中的空单元格是指不包含数据或仅包含样式信息的单元格。当此选项为 true 时，保存期间会排除这些单元格。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setExcludeEmptyRegionCells(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果保存工作簿时排除已用数据区域之外的空单元格，则为 true；否则为 false。
- getIncludeBindingSource
  
  public final boolean getIncludeBindingSource()
  获取保存文件时是否包含绑定源。
  此属性控制是否将绑定的数据源导出到 .xlsx 文件。默认值为 true。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIncludeBindingSource(false); boolean includeBindingSource = options.getIncludeBindingSource(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果保存文件时包含绑定源，则为 true；否则为 false。
- setIncludeBindingSource
  
  public final void setIncludeBindingSource(boolean value)
  设置保存文件时是否包含绑定源。
  此属性控制是否将绑定的数据源导出到 .xlsx 文件。默认值为 true。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIncludeBindingSource(false); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果保存文件时包含绑定源，则为 true；否则为 false。
- getIncludeAutoMergedCells
  
  public final boolean getIncludeAutoMergedCells()
  获取将工作簿保存为 .xlsx 文件时是否包含自动合并的单元格。
  当此选项为 true 时，导出期间会包含自动合并信息，因此自动合并的单元格会写入 .xlsx 文件。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIncludeAutoMergedCells(true); boolean includeAutoMergedCells = options.getIncludeAutoMergedCells(); workbook.save("path/to/output.xlsx", options);
  Returns:
  
  如果保存工作簿时包含自动合并的单元格，则为 true；否则为 false。
- setIncludeAutoMergedCells
  
  public final void setIncludeAutoMergedCells(boolean value)
  设置将工作簿保存为 .xlsx 文件时是否包含自动合并的单元格。
  当此选项为 true 时，导出期间会包含自动合并信息，因此自动合并的单元格会写入 .xlsx 文件。默认值为 false。
  
  XlsxSaveOptions options = new XlsxSaveOptions(); options.setIncludeAutoMergedCells(true); workbook.save("path/to/output.xlsx", options);
  Parameters:
  
  value - 如果保存工作簿时包含自动合并的单元格，则为 true；否则为 false。
- toString
  
  public String toString()
  
  Returns a string representation of these XLSX save options.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  A string representation of these XLSX save options.

XlsxSaveOptions

Class XlsxSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.grapecity.documents.excel.SaveOptionsBase

Methods inherited from class java.lang.Object

Constructor Details

XlsxSaveOptions

Method Details

getExportSharedFormula

setExportSharedFormula

getPassword

setPassword

getIsCompactMode

setIsCompactMode

getIgnoreFormulas

setIgnoreFormulas

getExcludeUnusedStyles

setExcludeUnusedStyles

getExcludeUnusedNames

setExcludeUnusedNames

getExcludeEmptyRegionCells

setExcludeEmptyRegionCells

getIncludeBindingSource

setIncludeBindingSource

getIncludeAutoMergedCells

setIncludeAutoMergedCells

toString