Skip to content

Commit 71394e3

Browse files
committed
Api reference of Aspose.Cells for Java 25.9
1 parent db73f85 commit 71394e3

File tree

22 files changed

+1540
-32
lines changed

22 files changed

+1540
-32
lines changed

english/java/com.aspose.cells/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,7 @@ Provides core apis and features to manipulate spreadsheet files and data directl
315315
| [HorizontalPageBreakCollection](../com.aspose.cells/horizontalpagebreakcollection) | Encapsulates a collection of [HorizontalPageBreak](../com.aspose.cells/horizontalpagebreak) objects. |
316316
| [HtmlConverter](../com.aspose.cells/htmlconverter) | Converter for conversion between html files(html or mht) and other spreadsheet file formats. |
317317
| [HtmlCrossType](../com.aspose.cells/htmlcrosstype) | Represents five types of html cross string. |
318+
| [HtmlEmbeddedFontType](../com.aspose.cells/htmlembeddedfonttype) | Represents the embedded font type in html. |
318319
| [HtmlExportDataOptions](../com.aspose.cells/htmlexportdataoptions) | Represents the options for exporting html data. |
319320
| [HtmlFormatHandlingType](../com.aspose.cells/htmlformathandlingtype) | Specifies how to handle formatting from the HTML source |
320321
| [HtmlHiddenColDisplayType](../com.aspose.cells/htmlhiddencoldisplaytype) | Represents two types of showing the hidden columns in html. |
@@ -596,6 +597,7 @@ Provides core apis and features to manipulate spreadsheet files and data directl
596597
| [RevisionType](../com.aspose.cells/revisiontype) | Represents the revision type. |
597598
| [Row](../com.aspose.cells/row) | Represents a single row in a worksheet. |
598599
| [RowCollection](../com.aspose.cells/rowcollection) | Collects the [Row](../com.aspose.cells/row) objects that represent the individual rows in a worksheet. |
600+
| [SaveElementType](../com.aspose.cells/saveelementtype) | Represents what kind of elements should be saved. |
599601
| [SaveFormat](../com.aspose.cells/saveformat) | Represents the format in which the workbook is saved. |
600602
| [SaveOptions](../com.aspose.cells/saveoptions) | Represents all save options |
601603
| [Scenario](../com.aspose.cells/scenario) | Represents an individual scenario. |

english/java/com.aspose.cells/copyoptions/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ When copying the range in the same file and the chart refers to the source sheet
146146

147147
**Remarks**
148148

149-
The default value is false, it works as MS Excel.
149+
The default value is false, it works as MS Excel. For example: if copying a chart with the data source "sheet1!A1:B10" from worksheet "sheet1 to other worksheet "sheet2", The data source will be changed as "sheet2!A1:B10"
150150

151151
**Returns:**
152152
boolean
@@ -273,7 +273,7 @@ When copying the range in the same file and the chart refers to the source sheet
273273

274274
**Remarks**
275275

276-
The default value is false, it works as MS Excel.
276+
The default value is false, it works as MS Excel. For example: if copying a chart with the data source "sheet1!A1:B10" from worksheet "sheet1 to other worksheet "sheet2", The data source will be changed as "sheet2!A1:B10"
277277

278278
**Parameters:**
279279
| Parameter | Type | Description |

english/java/com.aspose.cells/docxsaveoptions/_index.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Represents options of saving .docx file.
2525
| --- | --- |
2626
| [equals(Object arg0)](#equals-java.lang.Object-) | |
2727
| [getAllColumnsInOnePagePerSheet()](#getAllColumnsInOnePagePerSheet--) | If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. |
28+
| [getAsFlatOpc()](#getAsFlatOpc--) | Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
2829
| [getAsNormalView()](#getAsNormalView--) | Exporting Excel file to docx fiel as normal view. |
2930
| [getCachedFileFolder()](#getCachedFileFolder--) | The folder for temporary files that may be used as data cache. |
3031
| [getCheckExcelRestriction()](#getCheckExcelRestriction--) | Whether check restriction of excel file when user modify cells related objects. |
@@ -37,6 +38,7 @@ Represents options of saving .docx file.
3738
| [getDefaultEditLanguage()](#getDefaultEditLanguage--) | Gets default edit language. |
3839
| [getDefaultFont()](#getDefaultFont--) | When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. |
3940
| [getDrawObjectEventHandler()](#getDrawObjectEventHandler--) | Implements this interface to get DrawObject and Bound when rendering. |
41+
| [getEmbedXlsxAsChartDataSource()](#getEmbedXlsxAsChartDataSource--) | Indicates whether embedding an xlsx file as data source of the chart. |
4042
| [getEmfRenderSetting()](#getEmfRenderSetting--) | Setting for rendering Emf metafile. |
4143
| [getEncryptDocumentProperties()](#getEncryptDocumentProperties--) | Indicates whether encrypt document properties when saving as .xls file. |
4244
| [getGridlineColor()](#getGridlineColor--) | Gets gridline color. |
@@ -52,6 +54,7 @@ Represents options of saving .docx file.
5254
| [getRefreshChartCache()](#getRefreshChartCache--) | Indicates whether refreshing chart cache data |
5355
| [getSaveAsEditableShapes()](#getSaveAsEditableShapes--) | Save all drawing objects as editable shapes in the word file, so you can edit them in Word. |
5456
| [getSaveAsEditableShaps()](#getSaveAsEditableShaps--) | Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. |
57+
| [getSaveElementType()](#getSaveElementType--) | Indicates which elements should be saved. |
5558
| [getSaveFormat()](#getSaveFormat--) | Gets the save file format. |
5659
| [getSheetSet()](#getSheetSet--) | Gets the sheets to render. |
5760
| [getSortExternalNames()](#getSortExternalNames--) | Indicates whether sorting external defined names before saving file. |
@@ -65,6 +68,7 @@ Represents options of saving .docx file.
6568
| [notify()](#notify--) | |
6669
| [notifyAll()](#notifyAll--) | |
6770
| [setAllColumnsInOnePagePerSheet(boolean value)](#setAllColumnsInOnePagePerSheet-boolean-) | If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. |
71+
| [setAsFlatOpc(boolean value)](#setAsFlatOpc-boolean-) | Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
6872
| [setAsNormalView(boolean value)](#setAsNormalView-boolean-) | Exporting Excel file to docx fiel as normal view. |
6973
| [setCachedFileFolder(String value)](#setCachedFileFolder-java.lang.String-) | The folder for temporary files that may be used as data cache. |
7074
| [setCheckExcelRestriction(boolean value)](#setCheckExcelRestriction-boolean-) | Whether check restriction of excel file when user modify cells related objects. |
@@ -76,6 +80,7 @@ Represents options of saving .docx file.
7680
| [setDefaultEditLanguage(int value)](#setDefaultEditLanguage-int-) | Sets default edit language. |
7781
| [setDefaultFont(String value)](#setDefaultFont-java.lang.String-) | When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. |
7882
| [setDrawObjectEventHandler(DrawObjectEventHandler value)](#setDrawObjectEventHandler-com.aspose.cells.DrawObjectEventHandler-) | Implements this interface to get DrawObject and Bound when rendering. |
83+
| [setEmbedXlsxAsChartDataSource(boolean value)](#setEmbedXlsxAsChartDataSource-boolean-) | Indicates whether embedding an xlsx file as data source of the chart. |
7984
| [setEmfRenderSetting(int value)](#setEmfRenderSetting-int-) | Setting for rendering Emf metafile. |
8085
| [setEncryptDocumentProperties(boolean value)](#setEncryptDocumentProperties-boolean-) | Indicates whether encrypt document properties when saving as .xls file. |
8186
| [setFontSubstitutionCharGranularity(boolean value)](#setFontSubstitutionCharGranularity-boolean-) | Indicates whether to only substitute the font of character when the cell font is not compatibility for it. |
@@ -92,6 +97,7 @@ Represents options of saving .docx file.
9297
| [setRefreshChartCache(boolean value)](#setRefreshChartCache-boolean-) | Indicates whether refreshing chart cache data |
9398
| [setSaveAsEditableShapes(boolean value)](#setSaveAsEditableShapes-boolean-) | Save all drawing objects as editable shapes in the word file, so you can edit them in Word. |
9499
| [setSaveAsEditableShaps(boolean value)](#setSaveAsEditableShaps-boolean-) | Save all drawing objecgts as editable shapes in word file.So you can edit them in Word. |
100+
| [setSaveElementType(int value)](#setSaveElementType-int-) | Indicates which elements should be saved. |
95101
| [setSheetSet(SheetSet value)](#setSheetSet-com.aspose.cells.SheetSet-) | Sets the sheets to render. |
96102
| [setSortExternalNames(boolean value)](#setSortExternalNames-boolean-) | Indicates whether sorting external defined names before saving file. |
97103
| [setSortNames(boolean value)](#setSortNames-boolean-) | Indicates whether sorting defined names before saving file. |
@@ -147,6 +153,16 @@ public boolean getAllColumnsInOnePagePerSheet()
147153

148154
If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.
149155

156+
**Returns:**
157+
boolean
158+
### getAsFlatOpc() {#getAsFlatOpc--}
159+
```
160+
public boolean getAsFlatOpc()
161+
```
162+
163+
164+
Indicates whether saving as a flat opc file which can be generated by Open XML SDK
165+
150166
**Returns:**
151167
boolean
152168
### getAsNormalView() {#getAsNormalView--}
@@ -291,6 +307,20 @@ Implements this interface to get DrawObject and Bound when rendering.
291307

292308
**Returns:**
293309
[DrawObjectEventHandler](../../com.aspose.cells/drawobjecteventhandler)
310+
### getEmbedXlsxAsChartDataSource() {#getEmbedXlsxAsChartDataSource--}
311+
```
312+
public boolean getEmbedXlsxAsChartDataSource()
313+
```
314+
315+
316+
Indicates whether embedding an xlsx file as data source of the chart.
317+
318+
**Remarks**
319+
320+
The default value is true.
321+
322+
**Returns:**
323+
boolean
294324
### getEmfRenderSetting() {#getEmfRenderSetting--}
295325
```
296326
public int getEmfRenderSetting()
@@ -552,6 +582,18 @@ NOTE: This member is now obsolete. Instead, please use [getSaveAsEditableShapes(
552582

553583
**Returns:**
554584
boolean
585+
### getSaveElementType() {#getSaveElementType--}
586+
```
587+
public int getSaveElementType()
588+
```
589+
590+
591+
Indicates which elements should be saved.
592+
593+
See [SaveElementType](../../com.aspose.cells/saveelementtype).
594+
595+
**Returns:**
596+
int
555597
### getSaveFormat() {#getSaveFormat--}
556598
```
557599
public int getSaveFormat()
@@ -712,6 +754,19 @@ If AllColumnsInOnePagePerSheet is true , all column content of one sheet will ou
712754
| --- | --- | --- |
713755
| value | boolean | |
714756

757+
### setAsFlatOpc(boolean value) {#setAsFlatOpc-boolean-}
758+
```
759+
public void setAsFlatOpc(boolean value)
760+
```
761+
762+
763+
Indicates whether saving as a flat opc file which can be generated by Open XML SDK
764+
765+
**Parameters:**
766+
| Parameter | Type | Description |
767+
| --- | --- | --- |
768+
| value | boolean | |
769+
715770
### setAsNormalView(boolean value) {#setAsNormalView-boolean-}
716771
```
717772
public void setAsNormalView(boolean value)
@@ -877,6 +932,23 @@ Implements this interface to get DrawObject and Bound when rendering.
877932
| --- | --- | --- |
878933
| value | [DrawObjectEventHandler](../../com.aspose.cells/drawobjecteventhandler) | |
879934

935+
### setEmbedXlsxAsChartDataSource(boolean value) {#setEmbedXlsxAsChartDataSource-boolean-}
936+
```
937+
public void setEmbedXlsxAsChartDataSource(boolean value)
938+
```
939+
940+
941+
Indicates whether embedding an xlsx file as data source of the chart.
942+
943+
**Remarks**
944+
945+
The default value is true.
946+
947+
**Parameters:**
948+
| Parameter | Type | Description |
949+
| --- | --- | --- |
950+
| value | boolean | |
951+
880952
### setEmfRenderSetting(int value) {#setEmfRenderSetting-int-}
881953
```
882954
public void setEmfRenderSetting(int value)
@@ -1139,6 +1211,21 @@ NOTE: This member is now obsolete. Instead, please use [getSaveAsEditableShapes(
11391211
| --- | --- | --- |
11401212
| value | boolean | |
11411213

1214+
### setSaveElementType(int value) {#setSaveElementType-int-}
1215+
```
1216+
public void setSaveElementType(int value)
1217+
```
1218+
1219+
1220+
Indicates which elements should be saved.
1221+
1222+
See [SaveElementType](../../com.aspose.cells/saveelementtype).
1223+
1224+
**Parameters:**
1225+
| Parameter | Type | Description |
1226+
| --- | --- | --- |
1227+
| value | int | |
1228+
11421229
### setSheetSet(SheetSet value) {#setSheetSet-com.aspose.cells.SheetSet-}
11431230
```
11441231
public void setSheetSet(SheetSet value)

english/java/com.aspose.cells/ebooksaveoptions/_index.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Represents the options for saving ebook file.
4040
| [getDefaultFontName()](#getDefaultFontName--) | Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null. |
4141
| [getDisableCss()](#getDisableCss--) | Indicates whether only inline styles are applied, without relying on CSS. |
4242
| [getDisableDownlevelRevealedComments()](#getDisableDownlevelRevealedComments--) | Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. |
43+
| [getEmbeddedFontType()](#getEmbeddedFontType--) | Gets the type of font that embedded in html. |
4344
| [getEnableCssCustomProperties()](#getEnableCssCustomProperties--) | Optimize the output of html by using CSS custom properties. |
4445
| [getEncodeEntityAsCode()](#getEncodeEntityAsCode--) | Indicates whether the html character entities are replaced with decimal code. |
4546
| [getEncoding()](#getEncoding--) | If not set,use Encoding.UTF8 as default enconding type. |
@@ -127,6 +128,7 @@ Represents the options for saving ebook file.
127128
| [setDefaultFontName(String value)](#setDefaultFontName-java.lang.String-) | Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null. |
128129
| [setDisableCss(boolean value)](#setDisableCss-boolean-) | Indicates whether only inline styles are applied, without relying on CSS. |
129130
| [setDisableDownlevelRevealedComments(boolean value)](#setDisableDownlevelRevealedComments-boolean-) | Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. |
131+
| [setEmbeddedFontType(int value)](#setEmbeddedFontType-int-) | Sets the type of font that embedded in html. |
130132
| [setEnableCssCustomProperties(boolean value)](#setEnableCssCustomProperties-boolean-) | Optimize the output of html by using CSS custom properties. |
131133
| [setEncodeEntityAsCode(boolean value)](#setEncodeEntityAsCode-boolean-) | Indicates whether the html character entities are replaced with decimal code. |
132134
| [setEncoding(Encoding value)](#setEncoding-com.aspose.cells.Encoding-) | If not set,use Encoding.UTF8 as default enconding type. |
@@ -404,6 +406,18 @@ Indicates if disable Downlevel-revealed conditional comments when exporting file
404406

405407
**Returns:**
406408
boolean
409+
### getEmbeddedFontType() {#getEmbeddedFontType--}
410+
```
411+
public int getEmbeddedFontType()
412+
```
413+
414+
415+
Gets the type of font that embedded in html. Default value is [HtmlEmbeddedFontType.NONE](../../com.aspose.cells/htmlembeddedfonttype\#NONE) which indicates that it will not embed font in html.
416+
417+
See [HtmlEmbeddedFontType](../../com.aspose.cells/htmlembeddedfonttype).
418+
419+
**Returns:**
420+
int
407421
### getEnableCssCustomProperties() {#getEnableCssCustomProperties--}
408422
```
409423
public boolean getEnableCssCustomProperties()
@@ -1402,6 +1416,21 @@ Indicates if disable Downlevel-revealed conditional comments when exporting file
14021416
| --- | --- | --- |
14031417
| value | boolean | |
14041418

1419+
### setEmbeddedFontType(int value) {#setEmbeddedFontType-int-}
1420+
```
1421+
public void setEmbeddedFontType(int value)
1422+
```
1423+
1424+
1425+
Sets the type of font that embedded in html. Default value is [HtmlEmbeddedFontType.NONE](../../com.aspose.cells/htmlembeddedfonttype\#NONE) which indicates that it will not embed font in html.
1426+
1427+
See [HtmlEmbeddedFontType](../../com.aspose.cells/htmlembeddedfonttype).
1428+
1429+
**Parameters:**
1430+
| Parameter | Type | Description |
1431+
| --- | --- | --- |
1432+
| value | int | |
1433+
14051434
### setEnableCssCustomProperties(boolean value) {#setEnableCssCustomProperties-boolean-}
14061435
```
14071436
public void setEnableCssCustomProperties(boolean value)

english/java/com.aspose.cells/fileformattype/_index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Represents the file format types.
3535
| [EXCEL_4](#EXCEL-4) | Represents an Excel4.0 xls file. |
3636
| [EXCEL_95](#EXCEL-95) | Represents an Excel95 xls file. |
3737
| [EXCEL_97_TO_2003](#EXCEL-97-TO-2003) | Excel97-2003 spreadsheet file. |
38+
| [FLAT_OPC](#FLAT-OPC) | Flat opc file |
3839
| [FODS](#FODS) | Represents OpenDocument Flat XML Spreadsheet (.fods) file format. |
3940
| [GIF](#GIF) | Gif |
4041
| [GRAPH_CHART](#GRAPH-CHART) | Represents embedded graph chart. |
@@ -288,6 +289,14 @@ public static final int EXCEL_97_TO_2003
288289

289290
Excel97-2003 spreadsheet file.
290291

292+
### FLAT_OPC {#FLAT-OPC}
293+
```
294+
public static final int FLAT_OPC
295+
```
296+
297+
298+
Flat opc file
299+
291300
### FODS {#FODS}
292301
```
293302
public static final int FODS

0 commit comments

Comments
 (0)