LoadOptions Leave feedback

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

Properties	Description
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.
layoutNames	Specify which layouts to be converted
backgroundColor	A background color (for example: “Green”)
drawType	Type of drawing, “UseDrawColor” (default) - Allows to use common color, or “UseObjectColor” - Allows to use separate color for every object

{
    "layoutNames": ["Floor1", "Floor3"]
}

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

Properties	Description
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.
defaultFont	Default font for Cells document
fontSubstitutes	Substitute specific fonts when converting Cells document
showGridLines	Show grid lines
showHiddenSheets	Show hidden sheets
onePagePerSheet	Put whole sheet in a single page
convertRange	Convert specific range when converting to other than cells format. Example: “D1:F8”
skipEmptyRowsAndColumns	Skips empty rows and columns when converting
password	Password to unprotect protected document
printComments	Represents the way comments are printed with the sheet. Default is PrintNoComments. Values: PrintInPlace, PrintNoComments, PrintSheetEnd, PrintWithThreadedComments.

{
  "defaultFont": "Arial",
  "fontSubstitutes": [],
  "showGridLines": true,
  "showHiddenSheets": false,
  "onePagePerSheet": false,
  "convertRange": "",
  "skipEmptyRowsAndColumns": true,
  "password": "Pass123",
  "printComments": "PrintNoComments"
}

CsvLoadOptions - csv

Properties	Description
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.
separator	Delimiter of a Csv file
isMultiEncoded	True means the file contains several encodings
hasFormula	Indicates whether text is formula if it starts with “#”
convertNumericData	Indicates whether the string in the file is converted to numeric
convertDateTimeData	Indicates whether the string in the file is converted to DateTime

{
  "separator": ",",
  "isMultiencoded": false,
  "hasFormula": true,
  "convertNumericData": true,
  "convertDateTimeData": true
}

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

Properties	Description
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.
defaultFont	Default font for Diagram document.

{
  defaultFont: "Arial"
}

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

Properties	Description
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.
displayHeader	Display or hide the email header
displayFromEmailAddress	Display or hide “from” email address
displayEmailAddress	Display or hide email address
displayToEmailAddress	Display or hide “to” email address
displayCcEmailAddress	Display or hide “Cc” email address
displayBccEmailAddress	Display or hide “Bcc” email address
FieldLabels	The mapping between email message field and field text representation
PreserveOriginalDate	Defines whether need to keep original date header string in mail message when saving or not (Default value is true)

{
  "displayHeader": true,
  "displayFromEmailAddress": true,
  "displayEmailAddress": true,
  "displayToEmailAddress": true,
  "displayCcEmailAddress": true,
  "displayBccEmailAddress": true,
  "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

Properties	Description
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.
defaultFont	Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing

{
  "defaultFont": "Arial"
}

OneLoadOptions - one

Properties	Description
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.
defaultFont	Default font for Note document
fontSubstitutes	Substitute specific fonts when converting Note document
password	Password to unprotect protected document

{
  "defaultFont": "Arial",
  "fontSubstitutes": [],
  "password": "Pass123"
}

PdfLoadOptions - pdf

Properties	Description
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.
removeEmbeddedFiles	Remove embedded files
password	Password to unprotect protected document
hidePdfAnnotations	Hide annotations in Pdf documents
flattenAllFields	Flatten all the fields of the PDF form

{
  "removeEmbeddedFiles": false,
  "password": "Pass123",
  "hidePdfAnnotations": true,
  "flattenAllFields": true
}

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

Properties	Description
format	The 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.
defaultFont	Default font for rendering the presentation.
fontSubstitutes	Substitute specific fonts when converting Slides document.
password	Password to unprotect protected document.
showHiddenSlides	Show hidden slides.
commentsPosition	Represents the way comments are printed with the slide. Default is None. Values: None, Bottom, Right.
notesPosition	Represents the way notes are printed with the slide. Default is None. Values: None, BottomTruncated, BottomFull.
preserveDocumentStructure	Determines whether the document structure should be preserved when converting to PDF (default is false).
clearCustomDocumentProperties	Value indicating whether custom document properties should be cleared.
clearBuiltInDocumentProperties	Value indicating whether built-in document properties should be cleared.
convertOwned	Option to control whether the owned documents in the documents container must be converted.
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.
depth	Option 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

Properties	Description
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.
detectNumberingWithWhitespaces	Allows to specify how numbered list items are recognized when plain text document is converted
trailingSpacesOptions	Controls trailing space handling
leadingSpacesOptions	Controls leading space handling

{
  "detectNumberingWIthWhiteSpaces": true,
  "trailingSpacesOptions": "trim",
  "leadingSpacesOptions": "preserve"
}

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

Properties	Description
format	The 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.
defaultFont	Default font for Words document.
fontSubstitutes	Substitute specific fonts when converting Words document.
password	Password to unprotect protected document.
hideWordTrackedChanges	Hide markup and track changes for Word documents.
clearCustomDocumentProperties	Clear custom document properties. Default is false.
clearBuiltInDocumentProperties	Clear built-in document properties. Default is false.
depth	Option to control how many levels in depth to perform conversion. Default: 1.
convertOwned	Option to control whether the owned documents in the documents container must be converted.
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.
pageNumbering	Enable or disable generation of page numbering in converted document. Default: false.
skipExternalResources	If true, all external resources will not be loaded. Default is true.
useTextShaper	Specifies whether to use a text shaper for better kerning display. Default is false.
preserveFormFields	Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.
commentDisplayMode	Specifies how comments should be displayed in the output document. Default is Balloon.
keepDateFieldOriginalValue	Keep original value of date field. Default: false.
updateFields	Update fields after loading. Default: false.
updatePageLayout	Update page layout after loading. Default: false.
embedTrueTypeFonts	If true, GroupDocs.Conversion Cloud embeds true type fonts in the output document. Default: true.
fontInfoSubstitutionEnabled	Automatically substitutes missing fonts based on FontInfo in the document. Default: false.
fontConfigSubstitutionEnabled	Automatically substitutes missing fonts based on FontConfig in the system. Default: false.
fontNameSubstitutionEnabled	Automatically substitutes missing fonts based on the font name. Default: false.
showFullCommenterName	Show full commenter name in comments. Default is false.

{
  "defaultFont": "Arial",
  "fontSubstitutes": [],
  "password": "Pass123",
  "hideWordTrackedChanges": true,
  "clearCustomDocumentProperties": false,
  "clearBuiltInDocumentProperties": false,
  "depth": 1,
  "convertOwned": false,
  "convertOwner": 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

Properties	Description
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.
PageNumbering	Enable or disable generation of page numbering in converted document. Default: false

{
  "PageNumbering": true
}

We value your opinion. Your feedback will help us improve our documentation.

LoadOptions Leave feedback

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

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

CsvLoadOptions - csv

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

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

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

OneLoadOptions - one

PdfLoadOptions - pdf

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

TxtLoadOptions - txt

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

WebLoadOptions - html

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!