LoadOptions

CadLoadOptions - dxf, dwg, dgn, dwf, stl, Ifc, plt, Igs

PropertiesDescription
formatThe 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.
layoutNamesSpecify which layouts to be converted
backgroundColorA background color (for example: “Green”)
drawTypeType of drawing, “UseDrawColor” (default) - Allows to use common color, or “UseObjectColor” - Allows to use separate color for every object
drawColorA foreground/draw color (for example: “Red”)
{
    "layoutNames": ["Floor1", "Floor3"],
    "drawColor": "Red",
    "backgroundColor": "White"
}

SpreadsheetLoadOptions - xls, xlsx, xlsm, xlsb, xls2003, ods, ots, xltx, xltm, tsv, xlt

PropertiesDescription
formatThe 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.
defaultFontDefault font for Cells document
fontSubstitutesSubstitute specific fonts when converting Cells document
showGridLinesShow grid lines
showHiddenSheetsShow hidden sheets
onePagePerSheetPut whole sheet in a single page
convertRangeConvert specific range when converting to other than cells format. Example: “D1:F8”
skipEmptyRowsAndColumnsSkips empty rows and columns when converting
passwordPassword to unprotect protected document
printCommentsRepresents the way comments are printed with the sheet. Default is PrintNoComments. Values: PrintInPlace, PrintNoComments, PrintSheetEnd, PrintWithThreadedComments.
clearCustomDocumentPropertiesClear custom document properties. Default is false.
clearBuiltInDocumentPropertiesClear built-in document properties. Default is false.
rowsPerPageSplit a worksheet into pages by rows (pagination)
columnsPerPageSplit a worksheet into pages by columns (pagination)
autoFitRowsAutofits all rows when converting
allColumnsInOnePagePerSheetIf true, all columns in a sheet output to a single page
cultureInfoSystem culture info at the time file is loaded (e.g. “en-US”)
checkExcelRestrictionWhether to enforce Excel format restrictions when loading (e.g. 32K limit)
optimizePdfSizeIf true and converting to PDF, conversion optimized for smaller file size
sheetIndexesList of sheet indexes to convert (zero-based)
sheetsList of sheet names to convert
resetFontFoldersReset font folders before loading document
{
  "defaultFont": "Arial",
  "fontSubstitutes": {},
  "showGridLines": true,
  "showHiddenSheets": false,
  "onePagePerSheet": false,
  "convertRange": "",
  "skipEmptyRowsAndColumns": true,
  "password": "Pass123",
  "printComments": "PrintNoComments",
  "rowsPerPage": 0,
  "columnsPerPage": 0,
  "autoFitRows": false,
  "allColumnsInOnePagePerSheet": false,
  "cultureInfo": "en-US",
  "checkExcelRestriction": false,
  "optimizePdfSize": false,
  "sheetIndexes": [0],
  "sheets": ["Sheet1"],
  "resetFontFolders": false
}

CsvLoadOptions - csv

PropertiesDescription
formatThe 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.
separatorDelimiter of a Csv file (single character)
isMultiEncodedTrue means the file contains several encodings
hasFormulaIndicates whether text is formula if it starts with “=” (true/false)
convertNumericDataIndicates whether the string in the file is converted to numeric
convertDateTimeDataIndicates whether the string in the file is converted to DateTime
encodingFile encoding (e.g. “utf-8”)
{
  "separator": ",",
  "isMultiEncoded": false,
  "hasFormula": true,
  "convertNumericData": true,
  "convertDateTimeData": true,
  "encoding": "utf-8"
}

DiagramLoadOptions - vsd, vsdx, vss, vst, vsx, vtx, vdw, vdx, svg, vssx, vstx, vstm, vsdm, vssm

PropertiesDescription
formatThe 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.
defaultFontDefault font for Diagram document.
{
  "defaultFont": "Arial"
}

EmailLoadOptions - msg, eml, emlx, mht, ost, pst

PropertiesDescription
formatThe 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.
displayHeaderDisplay or hide the email header
displayFromEmailAddressDisplay or hide “from” email address
displayEmailAddressesDisplay or hide email addresses (shows addresses alongside names)
displayToEmailAddressDisplay or hide “to” email address
displayCcEmailAddressDisplay or hide “Cc” email address
displayBccEmailAddressDisplay or hide “Bcc” email address
displaySentDisplay or hide sent date/time in header
displaySubjectDisplay or hide subject in header
displayAttachmentsDisplay or hide attachments in header
fieldLabelsThe mapping between email message field and field text representation
preserveOriginalDateDefines whether need to keep original date header string in mail message when saving or not (Default value is true)
timeZoneOffsetUTC offset for message dates (e.g. “+00:00”)
defaultFontDefault font for Email document
fontSubstitutesSubstitute specific fonts when converting Email document
{
  "displayHeader": true,
  "displayFromEmailAddress": true,
  "displayEmailAddresses": true,
  "displayToEmailAddress": true,
  "displayCcEmailAddress": true,
  "displayBccEmailAddress": true,
  "preserveOriginalDate": true,
  "timeZoneOffset": "+00:00",
  "fieldLabels": [{
    "Field": "From",
    "Label": "Sender"
    }]
}

ImageLoadOptions - tiff, tif, jpeg, jpg, jp2, j2c, j2k, jpf, jpm, jpx, odg, png, gif, bmp, ico, psd, dcm, wmf, emf, webp

PropertiesDescription
formatThe 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.
defaultFontDefault font for Psd, Emf, Wmf document types. The following font will be used if a font is missing
{
  "defaultFont": "Arial"
}

NoteLoadOptions - one

PropertiesDescription
formatThe 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.
defaultFontDefault font for Note document
fontSubstitutesSubstitute specific fonts when converting Note document
passwordPassword to unprotect protected document
{
  "defaultFont": "Arial",
  "fontSubstitutes": [],
  "password": "Pass123"
}

PdfLoadOptions - pdf

PropertiesDescription
formatThe 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.
removeEmbeddedFilesRemove embedded files
removeJavascriptRemove javascript from PDF
passwordPassword to unprotect protected document
hidePdfAnnotationsHide annotations in Pdf documents
flattenAllFieldsFlatten all the fields of the PDF form
defaultFontDefault font for Pdf document. The following font will be used if a font is missing.
clearCustomDocumentPropertiesClear custom document properties
clearBuiltInDocumentPropertiesClear built-in document properties
pageNumberingEnable or disable generation of page numbering in converted document. Default: false
fontSubstitutesSubstitute specific fonts when converting PDF document
{
  "removeEmbeddedFiles": false,
  "removeJavascript": false,
  "password": "Pass123",
  "hidePdfAnnotations": true,
  "flattenAllFields": true,
  "defaultFont": "Arial",
  "clearCustomDocumentProperties": false,
  "clearBuiltInDocumentProperties": false,
  "pageNumbering": false,
  "fontSubstitutes": {}
}

PresentationLoadOptions - ppt, pps, pptx, ppsx, odp, otp, potx, potm, pptm, ppsm

PropertiesDescription
formatThe format of input file, (“docx”, for example). This field must be filled with correct input file format when using ConvertDirect method, which accepts input file as binary stream, so the API can correctly handle LoadOptions.
defaultFontDefault font for rendering the presentation.
fontSubstitutesSubstitute specific fonts when converting Slides document.
passwordPassword to unprotect protected document.
showHiddenSlidesShow hidden slides.
commentsPositionRepresents the way comments are printed with the slide. Default is None. Values: None, Bottom, Right.
notesPositionRepresents the way notes are printed with the slide. Default is None. Values: None, BottomTruncated, BottomFull.
preserveDocumentStructureDetermines whether the document structure should be preserved when converting to PDF (default is false).
clearCustomDocumentPropertiesValue indicating whether custom document properties should be cleared.
clearBuiltInDocumentPropertiesValue indicating whether built-in document properties should be cleared.
convertOwnedOption to control whether the owned documents in the documents container must be converted.
convertOwnerOption 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.
depthOption to control how many levels in depth to perform conversion. Default: 1
{
  "defaultFont": "Arial",
  "fontSubstitutes": [],
  "password": "Pass123",
  "showHiddenSlides": false,
  "commentsPosition": "None",
  "notesPosition": "None",
  "preserveDocumentStructure": false,
  "clearCustomDocumentProperties": false,
  "clearBuiltInDocumentProperties": false,
  "convertOwned": false,
  "convertOwner": true,
  "depth": 1
}

TxtLoadOptions - txt

PropertiesDescription
formatThe 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.
detectNumberingWithWhitespacesAllows to specify how numbered list items are recognized when plain text document is converted
trailingSpacesOptionsControls trailing space handling (Preserve / Trim)
leadingSpacesOptionsControls leading space handling (ConvertToIndent / Preserve / Trim)
encodingFile encoding used when loading txt (e.g. “utf-8”)
{
  "detectNumberingWithWhitespaces": true,
  "trailingSpacesOptions": "Trim",
  "leadingSpacesOptions": "ConvertToIndent",
  "encoding": "utf-8"
}

WordProcessingLoadOptions - doc, docm, docx, dot, dotm, dotx, rtf, odt, ott, mobi

PropertiesDescription
formatThe format of input file, (“docx”, for example). This field must be filled with correct input file format when using ConvertDirect method, which accepts input file as binary stream, so the API can correctly handle LoadOptions.
defaultFontDefault font for Words document.
fontSubstitutesSubstitute specific fonts when converting Words document.
passwordPassword to unprotect protected document.
hideWordTrackedChangesHide markup and track changes for Word documents.
bookmarksOutlineLevelSpecifies the default level in the document outline at which to display Word bookmarks. Default is 0.
headingsOutlineLevelsSpecifies how many levels of headings to include in the document outline.
expandedOutlineLevelsSpecifies how many levels in the document outline to show expanded when the file is viewed.
clearCustomDocumentPropertiesClear custom document properties. Default is false.
clearBuiltInDocumentPropertiesClear built-in document properties. Default is false.
depthOption to control how many levels in depth to perform conversion. Default: 1.
convertOwnedOption to control whether the owned documents in the documents container must be converted.
convertOwnerOption 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.
autoHyphenationDetermines whether automatic hyphenation is turned on for the document.
hyphenateCapsDetermines whether words written in all capitals are hyphenated.
pageNumberingEnable or disable generation of page numbering in converted document. Default: false.
skipExternalResourcesIf true, all external resources will not be loaded. Default is true.
useTextShaperSpecifies whether to use a text shaper for better kerning display. Default is false.
preserveFormFieldsSpecifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.
commentDisplayModeSpecifies how comments should be displayed in the output document. Default is Balloon.
keepDateFieldOriginalValueKeep original value of date field. Default: false.
updateFieldsUpdate fields after loading. Default: false.
updatePageLayoutUpdate page layout after loading. Default: false.
embedTrueTypeFontsIf true, GroupDocs.Conversion Cloud embeds TrueType fonts in output. Default: true.
fontInfoSubstitutionEnabledAutomatically substitutes missing fonts based on FontInfo in the document. Default: false.
fontConfigSubstitutionEnabledAutomatically substitutes missing fonts based on FontConfig in the system. Default: false.
fontNameSubstitutionEnabledAutomatically substitutes missing fonts based on the font name. Default: false.
showFullCommenterNameShow full commenter name in comments. Default is false.
{
  "defaultFont": "Arial",
  "fontSubstitutes": {},
  "password": "Pass123",
  "hideWordTrackedChanges": true,
  "bookmarksOutlineLevel": 0,
  "headingsOutlineLevels": 0,
  "expandedOutlineLevels": 0,
  "clearCustomDocumentProperties": false,
  "clearBuiltInDocumentProperties": false,
  "depth": 1,
  "convertOwned": false,
  "convertOwner": true,
  "autoHyphenation": false,
  "hyphenateCaps": true,
  "pageNumbering": false,
  "skipExternalResources": true,
  "useTextShaper": false,
  "preserveFormFields": false,
  "commentDisplayMode": "Balloon",
  "keepDateFieldOriginalValue": false,
  "updateFields": false,
  "updatePageLayout": false,
  "embedTrueTypeFonts": true,
  "fontInfoSubstitutionEnabled": false,
  "fontConfigSubstitutionEnabled": false,
  "fontNameSubstitutionEnabled": false,
  "showFullCommenterName": false
}

WebLoadOptions - html

PropertiesDescription
formatThe 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.
pageNumberingEnable or disable generation of page numbering in converted document. Default: false
basePathThe base path / base URL for resolving relative resources
encodingThe encoding to use when loading the HTML (null = determined from document)
skipExternalResourcesIf true all external resources will not be loaded
usePdfUse PDF engine for conversion. Default: false
renderingModeControls how HTML content is rendered. Values: Flow, AbsolutePositioning (default)
zoomSpecifies the zoom level as a percentage (default: 100)
pageLayoutSpecifies page layout options when loading web documents. Values: None, ScaleToPageWidth, ScaleToPageHeight
customCssStyleSets custom CSS to be injected into the document’s head prior to conversion
{
  "pageNumbering": true,
  "basePath": "https://example.com/",
  "encoding": "utf-8",
  "skipExternalResources": true,
  "usePdf": false,
  "renderingMode": "AbsolutePositioning",
  "zoom": 100,
  "pageLayout": "None",
  "customCssStyle": "body { font-family: Arial; }"
}

XmlLoadOptions - xml

PropertiesDescription
formatThe format of input file. Required for ConvertDirect scenario.
xslFoXSL document content to convert XML-FO using XSL (binary, supply as base64 in JSON payload)
{
  "xslFo": "PD94bWwgdmVyc2lvbj0iMS4wIj8+..." // base64-encoded XSL-FO bytes
}

VcfLoadOptions - vcf

PropertiesDescription
formatThe format of input file. Required for ConvertDirect scenario.
encodingThe encoding that will be used when loading Vcf document. Can be null.
{
  "encoding": "utf-8"
}
Close
Loading

Analyzing your prompt, please hold on...

An error occurred while retrieving the results. Please refresh the page and try again.