Skip to content

Commit 77cfc37

Browse files
SergeiTerentevSergeiTerentev
committed
Updates for v25.10
1 parent 2619607 commit 77cfc37

2 files changed

Lines changed: 127 additions & 26 deletions

File tree

‎build_docs.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ git submodule foreach 'git fetch origin; git checkout $(git rev-parse --abbrev-r
55
rm -rf docs-cloud-common/content/conversion
66
cp -R content docs-cloud-common
77
cd docs-cloud-common
8-
hugo server
8+
hugo server --config=config-geekdoc.toml

‎content/conversion/developer-guide/data-structures/loadoptions.md‎

Lines changed: 126 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ keywords: ""
1616
|layoutNames| Specify which layouts to be converted
1717
|backgroundColor|A background color (for example: "Green")
1818
|drawType|Type of drawing, "UseDrawColor" (default) - Allows to use common color, or "UseObjectColor" - Allows to use separate color for every object
19+
|drawColor|A foreground/draw color (for example: "Red")
1920

2021
```json
2122
{
22-
"layoutNames": ["Floor1", "Floor3"]
23+
"layoutNames": ["Floor1", "Floor3"],
24+
"drawColor": "Red",
25+
"backgroundColor": "White"
2326
}
2427
```
2528

26-
## SpreadsheetLoadOptions - xls, xlsx, xlsm, xlsb, xls2003, ods, ots, xltx, xltm, tsv
29+
## SpreadsheetLoadOptions - xls, xlsx, xlsm, xlsb, xls2003, ods, ots, xltx, xltm, tsv, xlt
2730

2831
| Properties | Description
2932
|---|---
@@ -37,18 +40,40 @@ keywords: ""
3740
|skipEmptyRowsAndColumns|Skips empty rows and columns when converting
3841
|password|Password to unprotect protected document
3942
|printComments|Represents the way comments are printed with the sheet. Default is PrintNoComments. Values: PrintInPlace, PrintNoComments, PrintSheetEnd, PrintWithThreadedComments.
43+
|clearCustomDocumentProperties|Clear custom document properties. Default is false.
44+
|clearBuiltInDocumentProperties|Clear built-in document properties. Default is false.
45+
|rowsPerPage|Split a worksheet into pages by rows (pagination)
46+
|columnsPerPage|Split a worksheet into pages by columns (pagination)
47+
|autoFitRows|Autofits all rows when converting
48+
|allColumnsInOnePagePerSheet|If true, all columns in a sheet output to a single page
49+
|cultureInfo|System culture info at the time file is loaded (e.g. "en-US")
50+
|checkExcelRestriction|Whether to enforce Excel format restrictions when loading (e.g. 32K limit)
51+
|optimizePdfSize|If true and converting to PDF, conversion optimized for smaller file size
52+
|sheetIndexes|List of sheet indexes to convert (zero-based)
53+
|sheets|List of sheet names to convert
54+
|resetFontFolders|Reset font folders before loading document
4055

4156
```json
4257
{
4358
"defaultFont": "Arial",
44-
"fontSubstitutes": [],
59+
"fontSubstitutes": {},
4560
"showGridLines": true,
4661
"showHiddenSheets": false,
4762
"onePagePerSheet": false,
4863
"convertRange": "",
4964
"skipEmptyRowsAndColumns": true,
5065
"password": "Pass123",
51-
"printComments": "PrintNoComments"
66+
"printComments": "PrintNoComments",
67+
"rowsPerPage": 0,
68+
"columnsPerPage": 0,
69+
"autoFitRows": false,
70+
"allColumnsInOnePagePerSheet": false,
71+
"cultureInfo": "en-US",
72+
"checkExcelRestriction": false,
73+
"optimizePdfSize": false,
74+
"sheetIndexes": [0],
75+
"sheets": ["Sheet1"],
76+
"resetFontFolders": false
5277
}
5378
```
5479

@@ -57,19 +82,21 @@ keywords: ""
5782
| Properties | Description
5883
|---|---
5984
|format| The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions.
60-
|separator|Delimiter of a Csv file
85+
|separator|Delimiter of a Csv file (single character)
6186
|isMultiEncoded|True means the file contains several encodings
62-
|hasFormula|Indicates whether text is formula if it starts with "#"
87+
|hasFormula|Indicates whether text is formula if it starts with "=" (true/false)
6388
|convertNumericData|Indicates whether the string in the file is converted to numeric
6489
|convertDateTimeData|Indicates whether the string in the file is converted to DateTime
90+
|encoding|File encoding (e.g. "utf-8")
6591

6692
```json
6793
{
6894
"separator": ",",
69-
"isMultiencoded": false,
95+
"isMultiEncoded": false,
7096
"hasFormula": true,
7197
"convertNumericData": true,
72-
"convertDateTimeData": true
98+
"convertDateTimeData": true,
99+
"encoding": "utf-8"
73100
}
74101
```
75102

@@ -82,7 +109,7 @@ keywords: ""
82109

83110
```json
84111
{
85-
defaultFont: "Arial"
112+
"defaultFont": "Arial"
86113
}
87114
```
88115

@@ -93,22 +120,30 @@ keywords: ""
93120
|format|The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions.
94121
|displayHeader|Display or hide the email header
95122
|displayFromEmailAddress|Display or hide "from" email address
96-
|displayEmailAddress|Display or hide email address
123+
|displayEmailAddresses|Display or hide email addresses (shows addresses alongside names)
97124
|displayToEmailAddress|Display or hide "to" email address
98125
|displayCcEmailAddress|Display or hide "Cc" email address
99126
|displayBccEmailAddress|Display or hide "Bcc" email address
100-
|FieldLabels|The mapping between email message field and field text representation
101-
|PreserveOriginalDate|Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
127+
|displaySent|Display or hide sent date/time in header
128+
|displaySubject|Display or hide subject in header
129+
|displayAttachments|Display or hide attachments in header
130+
|fieldLabels|The mapping between email message field and field text representation
131+
|preserveOriginalDate|Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
132+
|timeZoneOffset|UTC offset for message dates (e.g. "+00:00")
133+
|defaultFont|Default font for Email document
134+
|fontSubstitutes|Substitute specific fonts when converting Email document
102135

103136
```json
104137
{
105138
"displayHeader": true,
106139
"displayFromEmailAddress": true,
107-
"displayEmailAddress": true,
140+
"displayEmailAddresses": true,
108141
"displayToEmailAddress": true,
109142
"displayCcEmailAddress": true,
110143
"displayBccEmailAddress": true,
111-
"FieldLabels": [{
144+
"preserveOriginalDate": true,
145+
"timeZoneOffset": "+00:00",
146+
"fieldLabels": [{
112147
"Field": "From",
113148
"Label": "Sender"
114149
}]
@@ -128,7 +163,7 @@ keywords: ""
128163
}
129164
```
130165

131-
## OneLoadOptions - one
166+
## NoteLoadOptions - one
132167

133168
| Properties | Description
134169
|---|---
@@ -151,16 +186,28 @@ keywords: ""
151186
|---|---
152187
|format|The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions.
153188
|removeEmbeddedFiles|Remove embedded files
189+
|removeJavascript|Remove javascript from PDF
154190
|password|Password to unprotect protected document
155191
|hidePdfAnnotations|Hide annotations in Pdf documents
156192
|flattenAllFields|Flatten all the fields of the PDF form
193+
|defaultFont|Default font for Pdf document. The following font will be used if a font is missing.
194+
|clearCustomDocumentProperties|Clear custom document properties
195+
|clearBuiltInDocumentProperties|Clear built-in document properties
196+
|pageNumbering|Enable or disable generation of page numbering in converted document. Default: false
197+
|fontSubstitutes|Substitute specific fonts when converting PDF document
157198

158199
```json
159200
{
160201
"removeEmbeddedFiles": false,
202+
"removeJavascript": false,
161203
"password": "Pass123",
162204
"hidePdfAnnotations": true,
163-
"flattenAllFields": true
205+
"flattenAllFields": true,
206+
"defaultFont": "Arial",
207+
"clearCustomDocumentProperties": false,
208+
"clearBuiltInDocumentProperties": false,
209+
"pageNumbering": false,
210+
"fontSubstitutes": {}
164211
}
165212
```
166213

@@ -205,14 +252,16 @@ keywords: ""
205252
|---|---
206253
|format|The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions.
207254
|detectNumberingWithWhitespaces|Allows to specify how numbered list items are recognized when plain text document is converted
208-
|trailingSpacesOptions|Controls trailing space handling
209-
|leadingSpacesOptions|Controls leading space handling
255+
|trailingSpacesOptions|Controls trailing space handling (Preserve / Trim)
256+
|leadingSpacesOptions|Controls leading space handling (ConvertToIndent / Preserve / Trim)
257+
|encoding|File encoding used when loading txt (e.g. "utf-8")
210258

211259
```json
212260
{
213-
"detectNumberingWIthWhiteSpaces": true,
214-
"trailingSpacesOptions": "trim",
215-
"leadingSpacesOptions": "preserve"
261+
"detectNumberingWithWhitespaces": true,
262+
"trailingSpacesOptions": "Trim",
263+
"leadingSpacesOptions": "ConvertToIndent",
264+
"encoding": "utf-8"
216265
}
217266
```
218267

@@ -225,11 +274,16 @@ keywords: ""
225274
|fontSubstitutes|Substitute specific fonts when converting Words document.
226275
|password|Password to unprotect protected document.
227276
|hideWordTrackedChanges|Hide markup and track changes for Word documents.
277+
|bookmarksOutlineLevel|Specifies the default level in the document outline at which to display Word bookmarks. Default is 0.
278+
|headingsOutlineLevels|Specifies how many levels of headings to include in the document outline.
279+
|expandedOutlineLevels|Specifies how many levels in the document outline to show expanded when the file is viewed.
228280
|clearCustomDocumentProperties|Clear custom document properties. Default is false.
229281
|clearBuiltInDocumentProperties|Clear built-in document properties. Default is false.
230282
|depth|Option to control how many levels in depth to perform conversion. Default: 1.
231283
|convertOwned|Option to control whether the owned documents in the documents container must be converted.
232284
|convertOwner|Option to control whether the documents container itself must be converted. If this property is true, the documents container will be the first converted document. Default is true.
285+
|autoHyphenation|Determines whether automatic hyphenation is turned on for the document.
286+
|hyphenateCaps|Determines whether words written in all capitals are hyphenated.
233287
|pageNumbering|Enable or disable generation of page numbering in converted document. Default: false.
234288
|skipExternalResources|If true, all external resources will not be loaded. Default is true.
235289
|useTextShaper|Specifies whether to use a text shaper for better kerning display. Default is false.
@@ -238,7 +292,7 @@ keywords: ""
238292
|keepDateFieldOriginalValue|Keep original value of date field. Default: false.
239293
|updateFields|Update fields after loading. Default: false.
240294
|updatePageLayout|Update page layout after loading. Default: false.
241-
|embedTrueTypeFonts|If true, GroupDocs.Conversion Cloud embeds true type fonts in the output document. Default: true.
295+
|embedTrueTypeFonts|If true, GroupDocs.Conversion Cloud embeds TrueType fonts in output. Default: true.
242296
|fontInfoSubstitutionEnabled|Automatically substitutes missing fonts based on FontInfo in the document. Default: false.
243297
|fontConfigSubstitutionEnabled|Automatically substitutes missing fonts based on FontConfig in the system. Default: false.
244298
|fontNameSubstitutionEnabled|Automatically substitutes missing fonts based on the font name. Default: false.
@@ -247,14 +301,19 @@ keywords: ""
247301
```json
248302
{
249303
"defaultFont": "Arial",
250-
"fontSubstitutes": [],
304+
"fontSubstitutes": {},
251305
"password": "Pass123",
252306
"hideWordTrackedChanges": true,
307+
"bookmarksOutlineLevel": 0,
308+
"headingsOutlineLevels": 0,
309+
"expandedOutlineLevels": 0,
253310
"clearCustomDocumentProperties": false,
254311
"clearBuiltInDocumentProperties": false,
255312
"depth": 1,
256313
"convertOwned": false,
257314
"convertOwner": true,
315+
"autoHyphenation": false,
316+
"hyphenateCaps": true,
258317
"pageNumbering": false,
259318
"skipExternalResources": true,
260319
"useTextShaper": false,
@@ -276,10 +335,52 @@ keywords: ""
276335
| Properties | Description
277336
|---|---
278337
|format|The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions.
279-
|PageNumbering|Enable or disable generation of page numbering in converted document. Default: false
338+
|pageNumbering|Enable or disable generation of page numbering in converted document. Default: false
339+
|basePath|The base path / base URL for resolving relative resources
340+
|encoding|The encoding to use when loading the HTML (null = determined from document)
341+
|skipExternalResources|If true all external resources will not be loaded
342+
|usePdf|Use PDF engine for conversion. Default: false
343+
|renderingMode|Controls how HTML content is rendered. Values: Flow, AbsolutePositioning (default)
344+
|zoom|Specifies the zoom level as a percentage (default: 100)
345+
|pageLayout|Specifies page layout options when loading web documents. Values: None, ScaleToPageWidth, ScaleToPageHeight
346+
|customCssStyle|Sets custom CSS to be injected into the document's head prior to conversion
347+
348+
```json
349+
{
350+
"pageNumbering": true,
351+
"basePath": "https://example.com/",
352+
"encoding": "utf-8",
353+
"skipExternalResources": true,
354+
"usePdf": false,
355+
"renderingMode": "AbsolutePositioning",
356+
"zoom": 100,
357+
"pageLayout": "None",
358+
"customCssStyle": "body { font-family: Arial; }"
359+
}
360+
```
361+
362+
## XmlLoadOptions - xml
363+
364+
| Properties | Description
365+
|---|---
366+
|format|The format of input file. Required for ConvertDirect scenario.
367+
|xslFo|XSL document content to convert XML-FO using XSL (binary, supply as base64 in JSON payload)
368+
369+
```json
370+
{
371+
"xslFo": "PD94bWwgdmVyc2lvbj0iMS4wIj8+..." // base64-encoded XSL-FO bytes
372+
}
373+
```
374+
375+
## VcfLoadOptions - vcf
376+
377+
| Properties | Description
378+
|---|---
379+
|format|The format of input file. Required for ConvertDirect scenario.
380+
|encoding|The encoding that will be used when loading Vcf document. Can be null.
280381

281382
```json
282383
{
283-
"PageNumbering": true
384+
"encoding": "utf-8"
284385
}
285386
```

0 commit comments

Comments
 (0)