Connectors Reference

Cloudmersive Document Conversion

Convert API lets you effortlessly convert file formats and types.

 

Status: Preview

Tier: Premium

Version: v1

 

Actions:

Name

Summary

ConvertDocument_AutodetectGetInfo (file inputFile)

Get document type information

ConvertDocument_AutodetectToPdf (file inputFile)

Convert Document to PDF

ConvertDocument_AutodetectToPngArray (file inputFile)

Convert Document to PNG array

ConvertDocument_AutodetectToTxt (file inputFile, [Optional]string textFormattingMode)

Convert Document to Text (txt)

CompareDocument_Docx (file inputFile1, file inputFile2)

Compare Two Word DOCX

ConvertData_CsvToJson (file inputFile)

Convert CSV to JSON conversion

ConvertDocument_CsvToXlsx (file inputFile)

Convert CSV to Excel XLSX Spreadsheet

ConvertDocument_DocToDocx (file inputFile)

Convert Word DOC (97-03) Document to DOCX

ConvertDocument_DocToPdf (file inputFile)

Convert Word DOC (97-03) Document to PDF

ConvertDocument_DocToTxt (file inputFile)

Convert Word DOC (97-03) Document to Text (txt)

ConvertDocument_DocxToPdf (file inputFile)

Convert Word DOCX Document to PDF

ConvertDocument_DocxToTxt (file inputFile, [Optional]string textFormattingMode)

Convert Word DOCX Document to Text (txt)

EditDocument_BeginEditing (file inputFile)

Begin editing a document

EditDocument_DocxCreateBlankDocument (CreateBlankDocxRequest input)

Create a blank Word DOCX document

EditDocument_DocxDeletePages (RemoveDocxPagesRequest reqConfig)

Delete, remove pages from a Word DOCX document

EditDocument_DocxDeleteTableRow (DeleteDocxTableRowRequest reqConfig)

Deletes a table row in an existing table in a Word DOCX document

EditDocument_DocxDeleteTableRowRange (DeleteDocxTableRowRangeRequest reqConfig)

Deletes a range of multiple table rows in an existing table in a Word

EditDocument_DocxBody (GetDocxBodyRequest reqConfig)

Get body from a Word DOCX document

EditDocument_DocxGetCommentsHierarchical (GetDocxGetCommentsHierarchicalRequest reqConfig)

Get comments from a Word DOCX document hierarchically

EditDocument_DocxGetHeadersAndFooters (GetDocxHeadersAndFootersRequest reqConfig)

Get content of a footer from a Word DOCX document

EditDocument_DocxGetImages (GetDocxImagesRequest reqConfig)

Get images from a Word DOCX document

EditDocument_DocxPages (GetDocxPagesRequest reqConfig)

Get pages and content from a Word DOCX document

EditDocument_DocxGetSections (GetDocxSectionsRequest reqConfig)

Get sections from a Word DOCX document

EditDocument_DocxGetStyles (GetDocxStylesRequest reqConfig)

Get styles from a Word DOCX document

EditDocument_DocxGetTableRow (GetDocxTableRowRequest reqConfig)

Gets the contents of an existing table row in an existing table in a W

EditDocument_DocxGetTableByIndex (GetDocxTableByIndexRequest reqConfig)

Get a specific table by index in a Word DOCX document

EditDocument_DocxGetTables (GetDocxTablesRequest reqConfig)

Get all tables in Word DOCX document

EditDocument_DocxInsertCommentOnParagraph (DocxInsertCommentOnParagraphRequest reqConfig)

Insert a new comment into a Word DOCX document attached to a paragraph

EditDocument_DocxInsertImage (DocxInsertImageRequest reqConfig)

Insert image into a Word DOCX document

EditDocument_DocxInsertParagraph (InsertDocxInsertParagraphRequest reqConfig)

Insert a new paragraph into a Word DOCX document

EditDocument_DocxInsertTable (InsertDocxTablesRequest reqConfig)

Insert a new table into a Word DOCX document

EditDocument_DocxInsertTableRow (InsertDocxTableRowRequest reqConfig)

Insert a new row into an existing table in a Word DOCX document

EditDocument_DocxRemoveHeadersAndFooters (RemoveDocxHeadersAndFootersRequest reqConfig)

Remove headers and footers from Word DOCX document

EditDocument_DocxRemoveObject (DocxRemoveObjectRequest reqConfig)

Delete any object in a Word DOCX document

EditDocument_DocxReplace (ReplaceStringRequest reqConfig)

Replace string in Word DOCX document

EditDocument_DocxSetFooter (DocxSetFooterRequest reqConfig)

Set the footer in a Word DOCX document

EditDocument_DocxSetFooterAddPageNumber (DocxSetFooterAddPageNumberRequest reqConfig)

Add page number to footer in a Word DOCX document

EditDocument_DocxSetHeader (DocxSetHeaderRequest reqConfig)

Set the header in a Word DOCX document

EditDocument_DocxUpdateTableCell (UpdateDocxTableCellRequest reqConfig)

Update, set contents of a table cell in an existing table in a Word DO

EditDocument_DocxUpdateTableRow (UpdateDocxTableRowRequest reqConfig)

Update, set contents of a table row in an existing table in a Word DOCX document

EditDocument_FinishEditing (FinishEditingRequest reqConfig)

Finish editing document, and download result from document editing

EditDocument_PptxDeleteSlides (RemovePptxSlidesRequest reqConfig)

Delete, remove slides from a PowerPoint PPTX presentation document

EditDocument_PptxReplace (ReplaceStringRequest reqConfig)

Replace string in PowerPoint PPTX presentation

EditDocument_XlsxClearCellByIndex (ClearXlsxCellRequest input)

Clear cell contents in an Excel XLSX spreadsheet, worksheet by index

EditDocument_XlsxCreateBlankSpreadsheet (CreateBlankSpreadsheetRequest input)

Create a blank Excel XLSX spreadsheet

EditDocument_XlsxCreateSpreadsheetFromData (CreateSpreadsheetFromDataRequest input)

Create a new Excel XLSX spreadsheet from column and row data

EditDocument_XlsxDeleteWorksheet (RemoveXlsxWorksheetRequest reqConfig)

Delete, remove worksheet from an Excel XLSX spreadsheet document

EditDocument_XlsxGetCellByIdentifier (GetXlsxCellByIdentifierRequest input)

Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier

EditDocument_XlsxGetCellByIndex (GetXlsxCellRequest input)

Get cell from an Excel XLSX spreadsheet, worksheet by index

EditDocument_XlsxGetColumns (GetXlsxColumnsRequest input)

Get rows and cells from a Excel XLSX spreadsheet, worksheet

EditDocument_XlsxGetImages (GetXlsxImagesRequest input)

Get images from a Excel XLSX spreadsheet, worksheet

EditDocument_XlsxGetRowsAndCells (GetXlsxRowsAndCellsRequest input)

Get rows and cells from a Excel XLSX spreadsheet, worksheet

EditDocument_XlsxGetStyles (GetXlsxStylesRequest input)

Get styles from a Excel XLSX spreadsheet, worksheet

EditDocument_XlsxGetWorksheets (GetXlsxWorksheetsRequest input)

Get worksheets from a Excel XLSX spreadsheet

EditDocument_XlsxInsertWorksheet (InsertXlsxWorksheetRequest input)

Insert a new worksheet into an Excel XLSX spreadsheet

EditDocument_XlsxSetCellByIdentifier (SetXlsxCellByIdentifierRequest input)

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c

EditDocument_XlsxSetCellByIndex (SetXlsxCellRequest input)

Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index

ConvertWeb_HtmlToDocx (HtmlToOfficeRequest inputRequest)

Convert HTML to Word DOCX Document

ConvertDocument_HtmlToPdf (file inputFile)

Convert HTML document file to PDF Document

ConvertDocument_HtmlToPng (file inputFile)

Convert HTML document file to PNG image array

ConvertDocument_HtmlToTxt (file inputFile)

HTML Document file to Text (txt)

ConvertImage_MultipageImageFormatConvert (string format1, string format2, file inputFile)

Multi-page image format conversion

ConvertImage_GetImageInfo (file inputFile)

Get information about an image

ConvertImage_ImageSetDPI (integer dpi, file inputFile)

Change image DPI

ConvertImage_ImageFormatConvert (string format1, string format2, file inputFile)

Image format conversion

ConvertData_JsonToXml (ConvertData_JsonToXmlParameterJsonObject JsonObject)

Convert JSON to XML conversion

MergeDocument_Docx (file inputFile1, file inputFile2)

Merge Two Word DOCX Together

MergeDocument_DocxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Merge Multple Word DOCX Together

MergeDocument_Pdf (file inputFile1, file inputFile2)

Merge Two PDF Files Together

MergeDocument_PdfMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Merge Multple PDF Files Together

MergeDocument_Png (file inputFile1, file inputFile2)

Merge Multple PNG Files Together

MergeDocument_Pptx (file inputFile1, file inputFile2)

Merge Two PowerPoint PPTX Together

MergeDocument_PptxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Merge Multple PowerPoint PPTX Together

MergeDocument_Txt (file inputFile1, file inputFile2)

Merge Two Text (TXT) Files Together

MergeDocument_TxtMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Merge Multple Text (TXT) Files Together

MergeDocument_Xlsx (file inputFile1, file inputFile2)

Merge Two Excel XLSX Together

MergeDocument_XlsxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Merge Multple Excel XLSX Together

ConvertDocument_PdfToDocx (file inputFile)

Convert PDF to Word DOCX Document

ConvertDocument_PdfToDocxRasterize (file inputFile)

Convert PDF to Word DOCX Document based on rasterized version of the PDF

ConvertDocument_PdfToPngArray (file inputFile)

Convert PDF to PNG Image Array

ConvertDocument_PdfToPngSingle (file inputFile)

Convert PDF to Single PNG image

ConvertDocument_PdfToPptx (file inputFile)

Convert PDF to PowerPoint PPTX Presentation

ConvertDocument_PdfToTxt (file inputFile, [Optional]string textFormattingMode)

Convert PDF Document to Text (txt)

ConvertDocument_PngArrayToPdf (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

Convert PNG Array to PDF

ConvertDocument_PptToPdf (file inputFile)

Convert PowerPoint PPT (97-03) Presentation to PDF

ConvertDocument_PptToPptx (file inputFile)

Convert PowerPoint PPT (97-03) Presentation to PPTX

ConvertDocument_PptxToPdf (file inputFile)

Convert PowerPoint PPTX Presentation to PDF

ConvertDocument_PptxToTxt (file inputFile)

Convert PowerPoint PPTX Presentation to Text (txt)

SplitDocument_Docx (file inputFile, [Optional]boolean returnDocumentContents)

Split a single Word Document DOCX into Separate Documents by Page

SplitDocument_PdfByPage (file inputFile, [Optional]boolean returnDocumentContents)

Split a PDF file into separate PDF files, one per page

SplitDocument_Pptx (file inputFile, [Optional]boolean returnDocumentContents)

Split a single PowerPoint Presentation PPTX into Separate Slides

SplitDocument_TxtByLine (file inputFile)

Split a single Text file (txt) into lines

SplitDocument_TxtByString (file inputFile, string splitDelimiter, [Optional]boolean skipEmptyElements)

Split a single Text file (txt) by a string delimiter

SplitDocument_Xlsx (file inputFile, [Optional]boolean returnDocumentContents)

Split a single Excel XLSX into Separate Worksheets

ConvertTemplate_ApplyHtmlTemplate (HtmlTemplateApplicationRequest value)

Apply HTML template

ValidateDocument_AutodetectValidation (file inputFile)

Autodetect content type and validate

ValidateDocument_DocxValidation (file inputFile)

Validate a Word document (DOCX)

ValidateDocument_JsonValidation (file inputFile)

Validate a JSON file

ValidateDocument_PdfValidation (file inputFile)

Validate a PDF document file

ValidateDocument_PptxValidation (file inputFile)

Validate a PowerPoint presentation (PPTX)

ValidateDocument_XlsxValidation (file inputFile)

Validate a Excel document (XLSX)

ValidateDocument_XmlValidation (file inputFile)

Validate an XML file

ConvertWeb_HtmlToPdf (HtmlToPdfRequest input)

Convert HTML string to PDF

ConvertWeb_HtmlToPng (HtmlToPngRequest input)

Convert HTML string to PNG screenshot

ConvertWeb_HtmlToTxt (HtmlToTextRequest input)

Convert HTML string to text (txt)

ConvertWeb_MdToHtml (file inputFile)

Convert Markdown to HTML

ConvertWeb_UrlToPdf (ScreenshotRequest input)

Convert a URL to PDF

ConvertWeb_UrlToScreenshot (ScreenshotRequest input)

Take screenshot of URL

ConvertWeb_UrlToTxt (UrlToTextRequest input)

Convert website URL page to text (txt)

ConvertDocument_XlsToCsv (file inputFile)

Convert Excel XLS (97-03) Spreadsheet to CSV

ConvertData_XlsToJson (file inputFile)

Convert Excel (97-2003) XLS to JSON conversion

ConvertDocument_XlsToPdf (file inputFile)

Convert Excel XLS (97-03) Spreadsheet to PDF

ConvertDocument_XlsToXlsx (file inputFile)

Convert Excel XLS (97-03) Spreadsheet to XLSX

ConvertDocument_XlsxToCsv (file inputFile, [Optional]string outputEncoding)

Convert Excel XLSX Spreadsheet to CSV

ConvertData_XlsxToJson (file inputFile)

Convert Excel XLSX to JSON conversion

ConvertDocument_XlsxToPdf (file inputFile)

Convert Excel XLSX Spreadsheet to PDF

ConvertDocument_XlsxToTxt (file inputFile)

Convert Excel XLSX Spreadsheet to Text (txt)

ConvertData_XmlEditAddAttributeWithXPath (file inputFile, string XPathExpression, string XmlAttributeName, string XmlAttributeValue)

Adds an attribute to all XML nodes matching XPath expression

ConvertData_XmlEditAddChildWithXPath (file inputFile, string XPathExpression, string XmlNodeToAdd)

Adds an XML node as a child to XML nodes matching XPath expression

ConvertData_XmlRemoveWithXPath (string XPathExpression, file inputFile)

Remove, delete XML nodes and items matching XPath expression

ConvertData_XmlEditRemoveAllChildNodesWithXPath (file inputFile, string XPathExpression)

Removes, deletes all children of nodes matching XPath expression, but

ConvertData_XmlEditReplaceWithXPath (file inputFile, string XPathExpression, string XmlNodeReplacement)

Replaces XML nodes matching XPath expression with new node

ConvertData_XmlEditSetValueWithXPath (file inputFile, string XPathExpression, string XmlValue)

Sets the value contents of XML nodes matching XPath expression

ConvertData_XmlQueryWithXQuery (file inputFile, string XQuery)

Query an XML file using XQuery query, get results

ConvertData_XmlQueryWithXQueryMulti (file inputFile1, [Optional]file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10, string XQuery)

Query multiple XML files using XQuery query, get results

ConvertData_XmlFilterWithXPath (string XPathExpression, file inputFile)

Filter, select XML nodes using XPath expression, get results

ConvertData_XmlToJson (file inputFile)

Convert XML to JSON conversion

ConvertData_XmlTransformWithXsltToXml (file inputFile, file transformFile)

Transform XML document file with XSLT into a new XML document

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AlternateFileFormatCandidate

 

AutodetectDocumentValidationResult

 

AutodetectGetInfoResult

 

AutodetectToPngResult

 

ClearXlsxCellRequest

 

ClearXlsxCellResponse

 

ConvertData_CsvToJsonResponseItem

 

ConvertData_JsonToXmlParameterJsonObject

 

ConvertData_XlsToJsonResponseItem

 

ConvertData_XlsxToJsonResponseItem

 

ConvertData_XmlToJsonResponse

 

ConvertedPngPage

 

ConvertWeb_HtmlToPngResponse

 

CreateBlankDocxRequest

 

CreateBlankDocxResponse

 

CreateBlankSpreadsheetRequest

 

CreateBlankSpreadsheetResponse

 

CreateSpreadsheetFromDataRequest

 

CreateSpreadsheetFromDataResponse

 

DeleteDocxTableRowRangeRequest

 

DeleteDocxTableRowRangeResponse

 

DeleteDocxTableRowRequest

 

DeleteDocxTableRowResponse

 

DocumentValidationError

 

DocumentValidationResult

 

DocxBody

 

DocxCellStyle

 

DocxComment

 

DocxFooter

 

DocxHeader

 

DocxImage

 

DocxInsertCommentOnParagraphRequest

 

DocxInsertImageRequest

 

DocxInsertImageResponse

 

DocxPage

 

DocxParagraph

 

DocxRemoveObjectRequest

 

DocxRemoveObjectResponse

 

DocxRun

 

DocxSection

 

DocxSetFooterAddPageNumberRequest

 

DocxSetFooterRequest

 

DocxSetFooterResponse

 

DocxSetHeaderRequest

 

DocxSetHeaderResponse

 

DocxStyle

 

DocxTable

 

DocxTableCell

 

DocxTableRow

 

DocxText

 

DocxTopLevelComment

 

EditDocument_XlsxDeleteWorksheetResponse

 

ExifValue

 

file

Input file to perform the operation on.

FinishEditingRequest

 

GetDocxBodyRequest

 

GetDocxBodyResponse

 

GetDocxCommentsHierarchicalResponse

 

GetDocxGetCommentsHierarchicalRequest

 

GetDocxHeadersAndFootersRequest

 

GetDocxHeadersAndFootersResponse

 

GetDocxImagesRequest

 

GetDocxImagesResponse

 

GetDocxPagesRequest

 

GetDocxPagesResponse

 

GetDocxSectionsRequest

 

GetDocxSectionsResponse

 

GetDocxStylesRequest

 

GetDocxStylesResponse

 

GetDocxTableByIndexRequest

 

GetDocxTableByIndexResponse

 

GetDocxTableRowRequest

 

GetDocxTableRowResponse

 

GetDocxTablesRequest

 

GetDocxTablesResponse

 

GetImageInfoResult

 

GetXlsxCellByIdentifierRequest

 

GetXlsxCellByIdentifierResponse

 

GetXlsxCellRequest

 

GetXlsxCellResponse

 

GetXlsxColumnsRequest

 

GetXlsxColumnsResponse

 

GetXlsxImagesRequest

 

GetXlsxImagesResponse

 

GetXlsxRowsAndCellsRequest

 

GetXlsxRowsAndCellsResponse

 

GetXlsxStylesRequest

 

GetXlsxStylesResponse

 

GetXlsxWorksheetsRequest

 

GetXlsxWorksheetsResponse

 

HtmlMdResult

 

HtmlTemplateApplicationRequest

 

HtmlTemplateApplicationResponse

 

HtmlTemplateOperation

 

HtmlToOfficeRequest

 

HtmlToPdfRequest

 

HtmlToPngRequest

 

HtmlToTextRequest

 

HtmlToTextResponse

 

InsertDocxCommentOnParagraphResponse

 

InsertDocxInsertParagraphRequest

 

InsertDocxInsertParagraphResponse

 

InsertDocxTableRowRequest

 

InsertDocxTableRowResponse

 

InsertDocxTablesRequest

 

InsertDocxTablesResponse

 

InsertXlsxWorksheetRequest

 

InsertXlsxWorksheetResponse

 

MergeDocument_TxtResponse

 

MultipageImageFormatConversionResult

 

PageConversionResult

 

PdfDocument

 

PdfToPngResult

 

PresentationResult

 

RemoveDocxHeadersAndFootersRequest

 

RemoveDocxHeadersAndFootersResponse

 

RemoveDocxPagesRequest

 

RemovePptxSlidesRequest

 

RemoveXlsxWorksheetRequest

 

ReplaceStringRequest

 

ScreenshotRequest

 

SetXlsxCellByIdentifierRequest

 

SetXlsxCellByIdentifierResponse

 

SetXlsxCellRequest

 

SetXlsxCellResponse

 

SplitDocumentResult

 

SplitDocxDocumentResult

 

SplitPdfResult

 

SplitPptxPresentationResult

 

SplitTextDocumentByLinesResult

 

SplitTextDocumentByStringResult

 

SplitXlsxWorksheetResult

 

TextConversionResult

 

TextDocumentElement

 

TextDocumentLine

 

UpdateDocxTableCellRequest

 

UpdateDocxTableCellResponse

 

UpdateDocxTableRowRequest

 

UpdateDocxTableRowResponse

 

UrlToTextRequest

 

UrlToTextResponse

 

WorksheetResult

 

XlsxImage

 

XlsxSpreadsheetCell

 

XlsxSpreadsheetColumn

 

XlsxSpreadsheetRow

 

XlsxWorksheet

 

XmlAddAttributeWithXPathResult

 

XmlAddChildWithXPathResult

 

XmlFilterWithXPathResult

 

XmlQueryWithXQueryMultiResult

 

XmlQueryWithXQueryResult

 

XmlRemoveAllChildrenWithXPathResult

 

XmlRemoveWithXPathResult

 

XmlReplaceWithXPathResult

 

XmlSetValueWithXPathResult

 

 

Actions:

ConvertDocument_AutodetectGetInfo

Summary: Get document type information

Description: Auto-detects a document's type information; does not require file extension.  Analyzes file contents to confirm file type.  Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type.  Supports over 100 image file formats, Office document file formats, PDF, and more.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_AutodetectGetInfo (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:AutodetectGetInfoResult

          Description: Result of an autodetect/get-info operation

 

ConvertDocument_AutodetectToPdf

Summary: Convert Document to PDF

Description: Automatically detect file type and convert it to PDF.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_AutodetectToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_AutodetectToPngArray

Summary: Convert Document to PNG array

Description: Automatically detect file type and convert it to an array of PNG images.  Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_AutodetectToPngArray (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:AutodetectToPngResult

          Description: Result of converting an autodetected input to a PNG array

 

ConvertDocument_AutodetectToTxt

Summary: Convert Document to Text (txt)

Description: Automatically detect file type and convert it to Text.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.  For spreadsheets, all worksheets will be included.  If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_AutodetectToTxt (file inputFile, [Optional]string textFormattingMode)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

textFormattingMode

string

(Optional; specify how whitespace should be handled when converting the)

Optional; specify how whitespace should be handled when converting the

False

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

CompareDocument_Docx

Summary: Compare Two Word DOCX

Description: Compare two Office Word Documents (docx) files and highlight the differences

 

Syntax:

CloudmersiveDocumentConversion.CompareDocument_Docx (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertData_CsvToJson

Summary: Convert CSV to JSON conversion

Description: Convert a CSV file to a JSON object array

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_CsvToJson (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:array of (ConvertData_CsvToJsonResponseItem)

 

ConvertDocument_CsvToXlsx

Summary: Convert CSV to Excel XLSX Spreadsheet

Description: Convert CSV file to Office Excel XLSX Workbooks file format.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_CsvToXlsx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_DocToDocx

Summary: Convert Word DOC (97-03) Document to DOCX

Description: Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_DocToDocx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_DocToPdf

Summary: Convert Word DOC (97-03) Document to PDF

Description: Convert Office Word (97-2003 Format) Documents (doc) to standard PDF

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_DocToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_DocToTxt

Summary: Convert Word DOC (97-03) Document to Text (txt)

Description: Convert Office Word DOC (97-03) Document (doc) to text

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_DocToTxt (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

ConvertDocument_DocxToPdf

Summary: Convert Word DOCX Document to PDF

Description: Convert Office Word Documents (docx) to standard PDF

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_DocxToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_DocxToTxt

Summary: Convert Word DOCX Document to Text (txt)

Description: Convert Office Word Documents (docx) to text

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_DocxToTxt (file inputFile, [Optional]string textFormattingMode)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

textFormattingMode

string

(Optional; specify how whitespace should be handled when converting the)

Optional; specify how whitespace should be handled when converting the

False

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

EditDocument_BeginEditing

Summary: Begin editing a document

Description: Uploads a document to Cloudmersive to begin a series of one or more editing operations.  To edit a document, first call Begin Editing on the document.  Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table.  Finally, perform finish editing on the URL to return the resulting edited document.  The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_BeginEditing (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string

 

EditDocument_DocxCreateBlankDocument

Summary: Create a blank Word DOCX document

Description: Returns a blank Word DOCX Document format file.  The file is blank, with no contents.  Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxCreateBlankDocument (CreateBlankDocxRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

CreateBlankDocxRequest

 

Input to a Create Blank Word Document request

True

 

Returns:

          Type:CreateBlankDocxResponse

          Description: Result of creating a blank Word document

 

EditDocument_DocxDeletePages

Summary: Delete, remove pages from a Word DOCX document

Description: Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxDeletePages (RemoveDocxPagesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

RemoveDocxPagesRequest

 

Input to a Remove Word DOCX Document Pages request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

EditDocument_DocxDeleteTableRow

Summary: Deletes a table row in an existing table in a Word DOCX document

Description: Deletes an existing table row in a Word DOCX Document and returns the result.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxDeleteTableRow (DeleteDocxTableRowRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DeleteDocxTableRowRequest

 

Input to a delete DOCX table row request

True

 

Returns:

          Type:DeleteDocxTableRowResponse

          Description: Result of running an Delete Table Row command

 

EditDocument_DocxDeleteTableRowRange

Summary: Deletes a range of multiple table rows in an existing table in a Word

Description: Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxDeleteTableRowRange (DeleteDocxTableRowRangeRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DeleteDocxTableRowRangeRequest

 

Input to a delete DOCX table row range request

True

 

Returns:

          Type:DeleteDocxTableRowRangeResponse

          Description: Result of running an Delete Table Row Range command

 

EditDocument_DocxBody

Summary: Get body from a Word DOCX document

Description: Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxBody (GetDocxBodyRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxBodyRequest

 

Input to a Get Body request

True

 

Returns:

          Type:GetDocxBodyResponse

          Description: Result of running a Get-Body command

 

EditDocument_DocxGetCommentsHierarchical

Summary: Get comments from a Word DOCX document hierarchically

Description: Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetCommentsHierarchical (GetDocxGetCommentsHierarchicalRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxGetCommentsHierarchicalRequest

 

Input to a Get Word DOCX Document comments hierarchically request

True

 

Returns:

          Type:GetDocxCommentsHierarchicalResponse

          Description: Result of getting comments hierarchically from a Word Document DOCX

 

EditDocument_DocxGetHeadersAndFooters

Summary: Get content of a footer from a Word DOCX document

Description: Returns the footer content from a Word Document (DOCX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetHeadersAndFooters (GetDocxHeadersAndFootersRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxHeadersAndFootersRequest

 

Input to a Get Tables request

True

 

Returns:

          Type:GetDocxHeadersAndFootersResponse

          Description: Result of running a Get-Tables command

 

EditDocument_DocxGetImages

Summary: Get images from a Word DOCX document

Description: Returns the images defined in the Word Document (DOCX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetImages (GetDocxImagesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxImagesRequest

 

Input to a Get Images request

True

 

Returns:

          Type:GetDocxImagesResponse

          Description: Result of running a Get-Images command

 

EditDocument_DocxPages

Summary: Get pages and content from a Word DOCX document

Description: Returns the pages and contents of each page defined in the Word Document (DOCX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxPages (GetDocxPagesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxPagesRequest

 

Input to a Get Word DOCX Document Pages request

True

 

Returns:

          Type:GetDocxPagesResponse

          Description: Result of getting pages from a Word Document DOCX

 

EditDocument_DocxGetSections

Summary: Get sections from a Word DOCX document

Description: Returns the sections defined in the Word Document (DOCX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetSections (GetDocxSectionsRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxSectionsRequest

 

Input to a Get Sections request

True

 

Returns:

          Type:GetDocxSectionsResponse

          Description: Result of running a Get-Sections command

 

EditDocument_DocxGetStyles

Summary: Get styles from a Word DOCX document

Description: Returns the styles defined in the Word Document (DOCX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetStyles (GetDocxStylesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxStylesRequest

 

Input to a Get Tables request

True

 

Returns:

          Type:GetDocxStylesResponse

          Description: Result of running a Get-Tables command

 

EditDocument_DocxGetTableRow

Summary: Gets the contents of an existing table row in an existing table in a W

Description: Gets the contents of an existing table row in a Word DOCX Document and returns the result.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetTableRow (GetDocxTableRowRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxTableRowRequest

 

Input to a get DOCX table row request

True

 

Returns:

          Type:GetDocxTableRowResponse

          Description: Result of running an Get Table Row command

 

EditDocument_DocxGetTableByIndex

Summary: Get a specific table by index in a Word DOCX document

Description: Returns the specific table object by its 0-based index in an Office Word Document (DOCX)

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetTableByIndex (GetDocxTableByIndexRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxTableByIndexRequest

 

Input to a Get Tables by Index request

True

 

Returns:

          Type:GetDocxTableByIndexResponse

          Description: Result of running a Get-Tables by Index command

 

EditDocument_DocxGetTables

Summary: Get all tables in Word DOCX document

Description: Returns all the table objects in an Office Word Document (docx)

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxGetTables (GetDocxTablesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

GetDocxTablesRequest

 

Input to a Get Tables request

True

 

Returns:

          Type:GetDocxTablesResponse

          Description: Result of running a Get-Tables command

 

EditDocument_DocxInsertCommentOnParagraph

Summary: Insert a new comment into a Word DOCX document attached to a paragraph

Description: Adds a new comment into a Word DOCX document attached to a paragraph and returns the result.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxInsertCommentOnParagraph (DocxInsertCommentOnParagraphRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxInsertCommentOnParagraphRequest

 

Input to a Insert Comment on Paragraph request

True

 

Returns:

          Type:InsertDocxCommentOnParagraphResponse

          Description: Result of running an Insert-Comment-on-Paragraph command

 

EditDocument_DocxInsertImage

Summary: Insert image into a Word DOCX document

Description: Set the footer in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxInsertImage (DocxInsertImageRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxInsertImageRequest

 

Input to set-footer command

True

 

Returns:

          Type:DocxInsertImageResponse

          Description: Result of running a set-footer command

 

EditDocument_DocxInsertParagraph

Summary: Insert a new paragraph into a Word DOCX document

Description: Adds a new paragraph into a DOCX and returns the result.  You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document).  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxInsertParagraph (InsertDocxInsertParagraphRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

InsertDocxInsertParagraphRequest

 

Input to a Insert Paragraph request

True

 

Returns:

          Type:InsertDocxInsertParagraphResponse

          Description: Result of running an Insert-Paragraph command

 

EditDocument_DocxInsertTable

Summary: Insert a new table into a Word DOCX document

Description: Adds a new table into a DOCX and returns the result.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxInsertTable (InsertDocxTablesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

InsertDocxTablesRequest

 

Input to a Insert Tables request

True

 

Returns:

          Type:InsertDocxTablesResponse

          Description: Result of running an Insert-Tables command

 

EditDocument_DocxInsertTableRow

Summary: Insert a new row into an existing table in a Word DOCX document

Description: Adds a new table row into a DOCX Document and returns the result.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxInsertTableRow (InsertDocxTableRowRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

InsertDocxTableRowRequest

 

Input to a Insert Table Row request

True

 

Returns:

          Type:InsertDocxTableRowResponse

          Description: Result of running an Insert-Table Row command

 

EditDocument_DocxRemoveHeadersAndFooters

Summary: Remove headers and footers from Word DOCX document

Description: Remove all headers, or footers, or both from a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxRemoveHeadersAndFooters (RemoveDocxHeadersAndFootersRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

RemoveDocxHeadersAndFootersRequest

 

Input to a Remove Headers and Footers request

True

 

Returns:

          Type:RemoveDocxHeadersAndFootersResponse

          Description: Result of running a Remove Headers and Footers command

 

EditDocument_DocxRemoveObject

Summary: Delete any object in a Word DOCX document

Description: Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX).  Pass in the Path of the object you would like to delete.  You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxRemoveObject (DocxRemoveObjectRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxRemoveObjectRequest

 

Input to a Insert Paragraph request

True

 

Returns:

          Type:DocxRemoveObjectResponse

          Description: Result of running an Remove-Object command

 

EditDocument_DocxReplace

Summary: Replace string in Word DOCX document

Description: Replace all instances of a string in an Office Word Document (docx)

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxReplace (ReplaceStringRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

ReplaceStringRequest

 

Input to a string replacement request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

EditDocument_DocxSetFooter

Summary: Set the footer in a Word DOCX document

Description: Set the footer in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxSetFooter (DocxSetFooterRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxSetFooterRequest

 

Input to set-footer command

True

 

Returns:

          Type:DocxSetFooterResponse

          Description: Result of running a set-footer command

 

EditDocument_DocxSetFooterAddPageNumber

Summary: Add page number to footer in a Word DOCX document

Description: Set the footer in a Word Document (DOCX) to contain a page number.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxSetFooterAddPageNumber (DocxSetFooterAddPageNumberRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxSetFooterAddPageNumberRequest

 

Input to set-footer/add-page-number command

True

 

Returns:

          Type:DocxSetFooterResponse

          Description: Result of running a set-footer command

 

EditDocument_DocxSetHeader

Summary: Set the header in a Word DOCX document

Description: Set the header in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxSetHeader (DocxSetHeaderRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

DocxSetHeaderRequest

 

Input to a set-header command

True

 

Returns:

          Type:DocxSetHeaderResponse

          Description: Result of running a set-header command

 

EditDocument_DocxUpdateTableCell

Summary: Update, set contents of a table cell in an existing table in a Word DO

Description: Sets the contents of a table cell into a DOCX Document and returns the result.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxUpdateTableCell (UpdateDocxTableCellRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

UpdateDocxTableCellRequest

 

Input to a Update Table Cell request

True

 

Returns:

          Type:UpdateDocxTableCellResponse

          Description: Result of running an Update Table Cell command

 

EditDocument_DocxUpdateTableRow

Summary: Update, set contents of a table row in an existing table in a Word DOCX document

Description: Sets the contents of a table row into a DOCX Document and returns the result.  Call Finish Editing on the output URL to complete the operation.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_DocxUpdateTableRow (UpdateDocxTableRowRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

UpdateDocxTableRowRequest

 

Input to a Update Table Row request

True

 

Returns:

          Type:UpdateDocxTableRowResponse

          Description: Result of running an Update Table Row command

 

EditDocument_FinishEditing

Summary: Finish editing document, and download result from document editing

Description: Once done editing a document, download the result.  Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_FinishEditing (FinishEditingRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

FinishEditingRequest

 

Input to a Finish Editing request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

EditDocument_PptxDeleteSlides

Summary: Delete, remove slides from a PowerPoint PPTX presentation document

Description: Edits the input PowerPoint PPTX presentation document to remove the specified slides

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_PptxDeleteSlides (RemovePptxSlidesRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

RemovePptxSlidesRequest

 

Input to a Remove PowerPoint PPTX Presentation Slides request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

EditDocument_PptxReplace

Summary: Replace string in PowerPoint PPTX presentation

Description: Replace all instances of a string in an Office PowerPoint Document (pptx)

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_PptxReplace (ReplaceStringRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

ReplaceStringRequest

 

Input to a string replacement request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

EditDocument_XlsxClearCellByIndex

Summary: Clear cell contents in an Excel XLSX spreadsheet, worksheet by index

Description: Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxClearCellByIndex (ClearXlsxCellRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

ClearXlsxCellRequest

 

Input to a Clear Cell in XLSX Worksheet request

True

 

Returns:

          Type:ClearXlsxCellResponse

          Description: Result of running a Clear XLSX Cell command

 

EditDocument_XlsxCreateBlankSpreadsheet

Summary: Create a blank Excel XLSX spreadsheet

Description: Returns a blank Excel XLSX Spreadsheet (XLSX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxCreateBlankSpreadsheet (CreateBlankSpreadsheetRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

CreateBlankSpreadsheetRequest

 

Input to a Create Blank Spreadsheet request

True

 

Returns:

          Type:CreateBlankSpreadsheetResponse

          Description: Result of creating a blank worksheet

 

EditDocument_XlsxCreateSpreadsheetFromData

Summary: Create a new Excel XLSX spreadsheet from column and row data

Description: Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxCreateSpreadsheetFromData (CreateSpreadsheetFromDataRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

CreateSpreadsheetFromDataRequest

 

Input to Create a new Spreadsheet request

True

 

Returns:

          Type:CreateSpreadsheetFromDataResponse

          Description: Result of creating a new worksheet from rows and cells

 

EditDocument_XlsxDeleteWorksheet

Summary: Delete, remove worksheet from an Excel XLSX spreadsheet document

Description: Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab).  Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxDeleteWorksheet (RemoveXlsxWorksheetRequest reqConfig)

 

Parameters:

Name

Type

Summary

Required

Related Action

reqConfig

RemoveXlsxWorksheetRequest

 

Input to a Remove Excel XLSX Spreadsheet worksheet request

True

 

Returns:

          Type:EditDocument_XlsxDeleteWorksheetResponse

 

EditDocument_XlsxGetCellByIdentifier

Summary: Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier

Description: Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetCellByIdentifier (GetXlsxCellByIdentifierRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxCellByIdentifierRequest

 

Input to a Get Cell by cell identifier request

True

 

Returns:

          Type:GetXlsxCellByIdentifierResponse

          Description: Result of running a Get-Cell command

 

EditDocument_XlsxGetCellByIndex

Summary: Get cell from an Excel XLSX spreadsheet, worksheet by index

Description: Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetCellByIndex (GetXlsxCellRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxCellRequest

 

Input to a Get Cell request

True

 

Returns:

          Type:GetXlsxCellResponse

          Description: Result of running a Get-Cell command

 

EditDocument_XlsxGetColumns

Summary: Get rows and cells from a Excel XLSX spreadsheet, worksheet

Description: Returns the rows and cells defined in the Excel Spreadsheet worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetColumns (GetXlsxColumnsRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxColumnsRequest

 

Input to a Get Columns request

True

 

Returns:

          Type:GetXlsxColumnsResponse

          Description: Result of running a Get-Columns command

 

EditDocument_XlsxGetImages

Summary: Get images from a Excel XLSX spreadsheet, worksheet

Description: Returns the images defined in the Excel Spreadsheet worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetImages (GetXlsxImagesRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxImagesRequest

 

Input to a Get Images request

True

 

Returns:

          Type:GetXlsxImagesResponse

          Description: Result of running a Get-Images command

 

EditDocument_XlsxGetRowsAndCells

Summary: Get rows and cells from a Excel XLSX spreadsheet, worksheet

Description: Returns the rows and cells defined in the Excel Spreadsheet worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetRowsAndCells (GetXlsxRowsAndCellsRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxRowsAndCellsRequest

 

Input to a Get Worksheets request

True

 

Returns:

          Type:GetXlsxRowsAndCellsResponse

          Description: Result of running a Get-Worksheets command

 

EditDocument_XlsxGetStyles

Summary: Get styles from a Excel XLSX spreadsheet, worksheet

Description: Returns the style defined in the Excel Spreadsheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetStyles (GetXlsxStylesRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxStylesRequest

 

Input to a Get Worksheets request

True

 

Returns:

          Type:GetXlsxStylesResponse

          Description: Result of running a Get-Worksheets command

 

EditDocument_XlsxGetWorksheets

Summary: Get worksheets from a Excel XLSX spreadsheet

Description: Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxGetWorksheets (GetXlsxWorksheetsRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

GetXlsxWorksheetsRequest

 

Input to a Get Worksheets request

True

 

Returns:

          Type:GetXlsxWorksheetsResponse

          Description: Result of running a Get-Worksheets command

 

EditDocument_XlsxInsertWorksheet

Summary: Insert a new worksheet into an Excel XLSX spreadsheet

Description: Inserts a new worksheet into an Excel Spreadsheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxInsertWorksheet (InsertXlsxWorksheetRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

InsertXlsxWorksheetRequest

 

Input to a Get Worksheets request

True

 

Returns:

          Type:InsertXlsxWorksheetResponse

          Description: Result of running a Get-Worksheets command

 

EditDocument_XlsxSetCellByIdentifier

Summary: Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c

Description: Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxSetCellByIdentifier (SetXlsxCellByIdentifierRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

SetXlsxCellByIdentifierRequest

 

Input to a Set Cell by identifier in XLSX Worksheets request

True

 

Returns:

          Type:SetXlsxCellByIdentifierResponse

          Description: Result of running a Set Cell by identifier in XLSX Worksheets command

 

EditDocument_XlsxSetCellByIndex

Summary: Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index

Description: Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

 

Syntax:

CloudmersiveDocumentConversion.EditDocument_XlsxSetCellByIndex (SetXlsxCellRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

SetXlsxCellRequest

 

Input to a Set Cell in XLSX Worksheets request

True

 

Returns:

          Type:SetXlsxCellResponse

          Description: Result of running a Set Cell in XLSX Worksheets command

 

ConvertWeb_HtmlToDocx

Summary: Convert HTML to Word DOCX Document

Description: Convert HTML to Office Word Document (DOCX) format

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_HtmlToDocx (HtmlToOfficeRequest inputRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputRequest

HtmlToOfficeRequest

 

Details of the HTML to Office request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_HtmlToPdf

Summary: Convert HTML document file to PDF Document

Description: Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF.  To use external files such as images, use an absolute URL to the file.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_HtmlToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_HtmlToPng

Summary: Convert HTML document file to PNG image array

Description: Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page.  To use external files in your HTML such as images, use an absolute URL to the file.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_HtmlToPng (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:PdfToPngResult

          Description: Result of converting a PDF to a PNG array

 

ConvertDocument_HtmlToTxt

Summary: HTML Document file to Text (txt)

Description: HTML document to text

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_HtmlToTxt (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

ConvertImage_MultipageImageFormatConvert

Summary: Multi-page image format conversion

Description: Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).

 

Syntax:

CloudmersiveDocumentConversion.ConvertImage_MultipageImageFormatConvert (string format1, string format2, file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

format1

string

(Input file format as a 3+ letter file extension.  You can also provide)

Input file format as a 3+ letter file extension.  You can also provide

True

format2

string

(Output (convert to this format) file format as a 3+ letter file extens)

Output (convert to this format) file format as a 3+ letter file extens

True

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:MultipageImageFormatConversionResult

          Description: Result of converting a multi-page image into individual pages with a different format

 

ConvertImage_GetImageInfo

Summary: Get information about an image

Description: Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more

 

Syntax:

CloudmersiveDocumentConversion.ConvertImage_GetImageInfo (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:GetImageInfoResult

          Description: Result of running a get-info operation on an image

 

ConvertImage_ImageSetDPI

Summary: Change image DPI

Description: Resize an image to have a different DPI

 

Syntax:

CloudmersiveDocumentConversion.ConvertImage_ImageSetDPI (integer dpi, file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

dpi

integer(int32)

(New DPI in pixels-per-inch, for example 300 DPI or 600 DPI)

New DPI in pixels-per-inch, for example 300 DPI or 600 DPI

True

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertImage_ImageFormatConvert

Summary: Image format conversion

Description: Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.

 

Syntax:

CloudmersiveDocumentConversion.ConvertImage_ImageFormatConvert (string format1, string format2, file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

format1

string

(Input file format as a 3+ letter file extension.  You can also provide)

Input file format as a 3+ letter file extension.  You can also provide

True

format2

string

(Output (convert to this format) file format as a 3+ letter file extens)

Output (convert to this format) file format as a 3+ letter file extens

True

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertData_JsonToXml

Summary: Convert JSON to XML conversion

Description: Convert a JSON object into XML

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_JsonToXml (ConvertData_JsonToXmlParameterJsonObject JsonObject)

 

Parameters:

Name

Type

Summary

Required

Related Action

JsonObject

ConvertData_JsonToXmlParameterJsonObject

 

 

True

 

Returns:

          Type:string(byte)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Docx

Summary: Merge Two Word DOCX Together

Description: Combine two Office Word Documents (docx) into one single Office Word document

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Docx (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_DocxMulti

Summary: Merge Multple Word DOCX Together

Description: Combine multiple Office Word Documents (docx) into one single Office Word document

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_DocxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Pdf

Summary: Merge Two PDF Files Together

Description: Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Pdf (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_PdfMulti

Summary: Merge Multple PDF Files Together

Description: Combine multiple PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_PdfMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Png

Summary: Merge Multple PNG Files Together

Description: Combine multiple PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Png (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Pptx

Summary: Merge Two PowerPoint PPTX Together

Description: Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Pptx (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_PptxMulti

Summary: Merge Multple PowerPoint PPTX Together

Description: Combine multiple Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_PptxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Txt

Summary: Merge Two Text (TXT) Files Together

Description: Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Txt (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:MergeDocument_TxtResponse

 

MergeDocument_TxtMulti

Summary: Merge Multple Text (TXT) Files Together

Description: Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_TxtMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_Xlsx

Summary: Merge Two Excel XLSX Together

Description: Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_Xlsx (file inputFile1, file inputFile2)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on (more than 2 can be supplied).)

Second input file to perform the operation on (more than 2 can be supplied).

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

MergeDocument_XlsxMulti

Summary: Merge Multple Excel XLSX Together

Description: Combine multiple Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

 

Syntax:

CloudmersiveDocumentConversion.MergeDocument_XlsxMulti (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PdfToDocx

Summary: Convert PDF to Word DOCX Document

Description: Convert standard PDF to Office Word Documents (docx).    Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToDocx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PdfToDocxRasterize

Summary: Convert PDF to Word DOCX Document based on rasterized version of the PDF

Description: Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF.    Converts a PDF at high fidelity into Word format.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToDocxRasterize (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PdfToPngArray

Summary: Convert PDF to PNG Image Array

Description: Convert PDF document to PNG array, one image per page.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToPngArray (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:PdfToPngResult

          Description: Result of converting a PDF to a PNG array

 

ConvertDocument_PdfToPngSingle

Summary: Convert PDF to Single PNG image

Description: Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single "tall" image

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToPngSingle (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PdfToPptx

Summary: Convert PDF to PowerPoint PPTX Presentation

Description: Convert standard PDF to Office PowerPoint Presentation (pptx).  Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToPptx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PdfToTxt

Summary: Convert PDF Document to Text (txt)

Description: PDF document to text

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PdfToTxt (file inputFile, [Optional]string textFormattingMode)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

textFormattingMode

string

(Optional; specify how whitespace should be handled when converting PDF)

Optional; specify how whitespace should be handled when converting PDF

False

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

ConvertDocument_PngArrayToPdf

Summary: Convert PNG Array to PDF

Description: Convert an array of PNG images, one image per page, into a newly-created PDF.  Supports images of different sizes as input.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PngArrayToPdf (file inputFile1, file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input file to perform the operation on.)

First input file to perform the operation on.

True

inputFile2

file

(Second input file to perform the operation on.)

Second input file to perform the operation on.

True

inputFile3

file

(Third input file to perform the operation on.)

Third input file to perform the operation on.

False

inputFile4

file

(Fourth input file to perform the operation on.)

Fourth input file to perform the operation on.

False

inputFile5

file

(Fifth input file to perform the operation on.)

Fifth input file to perform the operation on.

False

inputFile6

file

(Sixth input file to perform the operation on.)

Sixth input file to perform the operation on.

False

inputFile7

file

(Seventh input file to perform the operation on.)

Seventh input file to perform the operation on.

False

inputFile8

file

(Eighth input file to perform the operation on.)

Eighth input file to perform the operation on.

False

inputFile9

file

(Ninth input file to perform the operation on.)

Ninth input file to perform the operation on.

False

inputFile10

file

(Tenth input file to perform the operation on.)

Tenth input file to perform the operation on.

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PptToPdf

Summary: Convert PowerPoint PPT (97-03) Presentation to PDF

Description: Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PptToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PptToPptx

Summary: Convert PowerPoint PPT (97-03) Presentation to PPTX

Description: Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PptToPptx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PptxToPdf

Summary: Convert PowerPoint PPTX Presentation to PDF

Description: Convert Office PowerPoint Documents (pptx) to standard PDF

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PptxToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_PptxToTxt

Summary: Convert PowerPoint PPTX Presentation to Text (txt)

Description: Convert Office PowerPoint Documents (pptx) to standard Text

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_PptxToTxt (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

SplitDocument_Docx

Summary: Split a single Word Document DOCX into Separate Documents by Page

Description: Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_Docx (file inputFile, [Optional]boolean returnDocumentContents)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

returnDocumentContents

boolean

(Set to true to return the contents of each Worksheet directly, set to)

Set to true to return the contents of each Worksheet directly, set to

False

 

Returns:

          Type:SplitDocxDocumentResult

          Description: The result of splitting a Word document into individual Word DOCX pages

 

SplitDocument_PdfByPage

Summary: Split a PDF file into separate PDF files, one per page

Description: Split an input PDF file into separate pages, comprised of one PDF file per page.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_PdfByPage (file inputFile, [Optional]boolean returnDocumentContents)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

returnDocumentContents

boolean

(Set to true to directly return all of the document contents in the Doc)

Set to true to directly return all of the document contents in the Doc

False

 

Returns:

          Type:SplitPdfResult

          Description: Result of performing a PDF file split operation

 

SplitDocument_Pptx

Summary: Split a single PowerPoint Presentation PPTX into Separate Slides

Description: Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_Pptx (file inputFile, [Optional]boolean returnDocumentContents)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

returnDocumentContents

boolean

(Set to true to return the contents of each presentation directly, set)

Set to true to return the contents of each presentation directly, set

False

 

Returns:

          Type:SplitPptxPresentationResult

          Description: The result of splitting a presentation into individual PowerPoint PPTX slides

 

SplitDocument_TxtByLine

Summary: Split a single Text file (txt) into lines

Description: Split a Text (txt) Document by line, returning each line separately in order.  Supports multiple types of newlines.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_TxtByLine (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:SplitTextDocumentByLinesResult

          Description: The result of splitting a Text document into separate lines

 

SplitDocument_TxtByString

Summary: Split a single Text file (txt) by a string delimiter

Description: Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_TxtByString (file inputFile, string splitDelimiter, [Optional]boolean skipEmptyElements)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

splitDelimiter

string

(Required; String to split up the input file on)

Required; String to split up the input file on

True

skipEmptyElements

boolean

(Optional; If true, empty elements will be skipped in the output)

Optional; If true, empty elements will be skipped in the output

False

 

Returns:

          Type:SplitTextDocumentByStringResult

          Description: The result of splitting a Text document into separate elements

 

SplitDocument_Xlsx

Summary: Split a single Excel XLSX into Separate Worksheets

Description: Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

 

Syntax:

CloudmersiveDocumentConversion.SplitDocument_Xlsx (file inputFile, [Optional]boolean returnDocumentContents)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

returnDocumentContents

boolean

(Set to true to return the contents of each Worksheet directly, set to)

Set to true to return the contents of each Worksheet directly, set to

False

 

Returns:

          Type:SplitXlsxWorksheetResult

          Description: The result of splitting a spreadsheet into individual Excel XLSX worksheets

 

ConvertTemplate_ApplyHtmlTemplate

Summary: Apply HTML template

Description: Apply operations to fill in an HTML template, generating a final HTML result

 

Syntax:

CloudmersiveDocumentConversion.ConvertTemplate_ApplyHtmlTemplate (HtmlTemplateApplicationRequest value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

HtmlTemplateApplicationRequest

 

HTML template application request

True

 

Returns:

          Type:HtmlTemplateApplicationResponse

          Description: Response from an HTML template application

 

ValidateDocument_AutodetectValidation

Summary: Autodetect content type and validate

Description: Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_AutodetectValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:AutodetectDocumentValidationResult

          Description: Document validation result

 

ValidateDocument_DocxValidation

Summary: Validate a Word document (DOCX)

Description: Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_DocxValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ValidateDocument_JsonValidation

Summary: Validate a JSON file

Description: Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_JsonValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ValidateDocument_PdfValidation

Summary: Validate a PDF document file

Description: Validate a PDF document; if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_PdfValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ValidateDocument_PptxValidation

Summary: Validate a PowerPoint presentation (PPTX)

Description: Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_PptxValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ValidateDocument_XlsxValidation

Summary: Validate a Excel document (XLSX)

Description: Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_XlsxValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ValidateDocument_XmlValidation

Summary: Validate an XML file

Description: Validate an XML document file; if the document is not valid, identifies the errors in the document

 

Syntax:

CloudmersiveDocumentConversion.ValidateDocument_XmlValidation (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:DocumentValidationResult

          Description: Document validation result

 

ConvertWeb_HtmlToPdf

Summary: Convert HTML string to PDF

Description: Fully renders a website and returns a PDF of the HTML.  Javascript, HTML5, CSS and other advanced features are all supported.

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_HtmlToPdf (HtmlToPdfRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

HtmlToPdfRequest

 

Details of the HTML to PDF request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertWeb_HtmlToPng

Summary: Convert HTML string to PNG screenshot

Description: Fully renders a website and returns a PNG (screenshot) of the HTML.  Javascript, HTML5, CSS and other advanced features are all supported.

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_HtmlToPng (HtmlToPngRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

HtmlToPngRequest

 

Details of the HTML to PNG request

True

 

Returns:

          Type:ConvertWeb_HtmlToPngResponse

 

ConvertWeb_HtmlToTxt

Summary: Convert HTML string to text (txt)

Description: Converts an HTML string input into text (txt); extracts text from HTML

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_HtmlToTxt (HtmlToTextRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

HtmlToTextRequest

 

Details of the HTML to Text request

True

 

Returns:

          Type:HtmlToTextResponse

          Description: Result of running the HTML to Text operation

 

ConvertWeb_MdToHtml

Summary: Convert Markdown to HTML

Description: Convert a markdown file (.md) to HTML

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_MdToHtml (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:HtmlMdResult

          Description: Result from converting a Markdown file to HTML

 

ConvertWeb_UrlToPdf

Summary: Convert a URL to PDF

Description: Fully renders a website and returns a PDF of the full page.  Javascript, HTML5, CSS and other advanced features are all supported.

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_UrlToPdf (ScreenshotRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

ScreenshotRequest

 

Details of the screenshot request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertWeb_UrlToScreenshot

Summary: Take screenshot of URL

Description: Fully renders a website and returns a PNG screenshot of the full page image.  Javascript, HTML5, CSS and other advanced features are all supported.

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_UrlToScreenshot (ScreenshotRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

ScreenshotRequest

 

Details of the screenshot request

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertWeb_UrlToTxt

Summary: Convert website URL page to text (txt)

Description: Converts a website URL page into text (txt); extracts text from HTML

 

Syntax:

CloudmersiveDocumentConversion.ConvertWeb_UrlToTxt (UrlToTextRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

UrlToTextRequest

 

Details of the URL website to Text request

True

 

Returns:

          Type:UrlToTextResponse

          Description: Result of running the URL website to Text operation

 

ConvertDocument_XlsToCsv

Summary: Convert Excel XLS (97-03) Spreadsheet to CSV

Description: Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsToCsv (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertData_XlsToJson

Summary: Convert Excel (97-2003) XLS to JSON conversion

Description: Convert an Excel (97-2003) XLS file to a JSON object array

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XlsToJson (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:array of (ConvertData_XlsToJsonResponseItem)

 

ConvertDocument_XlsToPdf

Summary: Convert Excel XLS (97-03) Spreadsheet to PDF

Description: Convert Office Excel (97-2003) Workbooks (xls) to standard PDF.  Converts all worksheets in the workbook to PDF.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_XlsToXlsx

Summary: Convert Excel XLS (97-03) Spreadsheet to XLSX

Description: Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsToXlsx (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_XlsxToCsv

Summary: Convert Excel XLSX Spreadsheet to CSV

Description: Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format.  Supports both XLSX and XLSB file Excel formats.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsxToCsv (file inputFile, [Optional]string outputEncoding)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

outputEncoding

string

(Optional, set the output text encoding for the result; possible values)

Optional, set the output text encoding for the result; possible values

False

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertData_XlsxToJson

Summary: Convert Excel XLSX to JSON conversion

Description: Convert an Excel XLSX file to a JSON object array

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XlsxToJson (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:array of (ConvertData_XlsxToJsonResponseItem)

 

ConvertDocument_XlsxToPdf

Summary: Convert Excel XLSX Spreadsheet to PDF

Description: Convert Office Excel Workbooks (XLSX) to standard PDF.  Converts all worksheets in the workbook to PDF.  Supports both XLSX and XLSB Excel file formats.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsxToPdf (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

ConvertDocument_XlsxToTxt

Summary: Convert Excel XLSX Spreadsheet to Text (txt)

Description: Convert Office Excel Workbooks (XLSX) to standard Text.  Converts all worksheets in the workbook to Text.  Supports both XLSX and XLSB file formats.  When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets.  If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.

 

Syntax:

CloudmersiveDocumentConversion.ConvertDocument_XlsxToTxt (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:TextConversionResult

          Description: Text conversion result from converting a document to Plain Text (TXT) format

 

ConvertData_XmlEditAddAttributeWithXPath

Summary: Adds an attribute to all XML nodes matching XPath expression

Description: Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlEditAddAttributeWithXPath (file inputFile, string XPathExpression, string XmlAttributeName, string XmlAttributeValue)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

XmlAttributeName

string

(Name of the XML attribute to add)

Name of the XML attribute to add

True

XmlAttributeValue

string

(Value of the XML attribute to add)

Value of the XML attribute to add

True

 

Returns:

          Type:XmlAddAttributeWithXPathResult

          Description: Result of performing a add attribute node operation on XML input using XPath

 

ConvertData_XmlEditAddChildWithXPath

Summary: Adds an XML node as a child to XML nodes matching XPath expression

Description: Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlEditAddChildWithXPath (file inputFile, string XPathExpression, string XmlNodeToAdd)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

XmlNodeToAdd

string

(XML Node to add as a child)

XML Node to add as a child

True

 

Returns:

          Type:XmlAddChildWithXPathResult

          Description: Result of performing a add child node operation on XML input using XPath

 

ConvertData_XmlRemoveWithXPath

Summary: Remove, delete XML nodes and items matching XPath expression

Description: Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlRemoveWithXPath (string XPathExpression, file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:XmlRemoveWithXPathResult

          Description: Result of performing a filter operation on XML input using XPath

 

ConvertData_XmlEditRemoveAllChildNodesWithXPath

Summary: Removes, deletes all children of nodes matching XPath expression, but

Description: Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlEditRemoveAllChildNodesWithXPath (file inputFile, string XPathExpression)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

 

Returns:

          Type:XmlRemoveAllChildrenWithXPathResult

          Description: Result of performing a remove all child nodes operation on XML input using XPath

 

ConvertData_XmlEditReplaceWithXPath

Summary: Replaces XML nodes matching XPath expression with new node

Description: Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlEditReplaceWithXPath (file inputFile, string XPathExpression, string XmlNodeReplacement)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

XmlNodeReplacement

string

(XML Node replacement content)

XML Node replacement content

True

 

Returns:

          Type:XmlReplaceWithXPathResult

          Description: Result of performing a replace node operation on XML input using XPath

 

ConvertData_XmlEditSetValueWithXPath

Summary: Sets the value contents of XML nodes matching XPath expression

Description: Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression.  Supports elements and attributes.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlEditSetValueWithXPath (file inputFile, string XPathExpression, string XmlValue)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

XmlValue

string

(XML Value to set into the matching XML nodes)

XML Value to set into the matching XML nodes

True

 

Returns:

          Type:XmlSetValueWithXPathResult

          Description: Result of performing a set value operation on XML input using XPath

 

ConvertData_XmlQueryWithXQuery

Summary: Query an XML file using XQuery query, get results

Description: Return the reuslts of querying a single XML document with an XQuery expression.  Supports XQuery 3.1 and earlier.  This API is optimized for a single XML document as input.  Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlQueryWithXQuery (file inputFile, string XQuery)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

XQuery

string

(Valid XML XQuery 3.1 or earlier query expression; multi-line expressio)

Valid XML XQuery 3.1 or earlier query expression; multi-line expressio

True

 

Returns:

          Type:XmlQueryWithXQueryResult

          Description: Result of performing an XQuery operation on an XML document.

 

ConvertData_XmlQueryWithXQueryMulti

Summary: Query multiple XML files using XQuery query, get results

Description: Return the reuslts of querying an XML document with an XQuery expression.  Supports XQuery 3.1 and earlier.  This API is optimized for multiple XML documents as input.  You can refer to the contents of a given document by name, for example doc("books.xml") or doc("restaurants.xml") if you included two input files named books.xml and restaurants.xml.  If input files contain no file name, they will default to file names input1.xml, input2.xml and so on.

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlQueryWithXQueryMulti (file inputFile1, [Optional]file inputFile2, [Optional]file inputFile3, [Optional]file inputFile4, [Optional]file inputFile5, [Optional]file inputFile6, [Optional]file inputFile7, [Optional]file inputFile8, [Optional]file inputFile9, [Optional]file inputFile10, string XQuery)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile1

file

(First input XML file to perform the operation on.)

First input XML file to perform the operation on.

True

inputFile2

file

(Second input XML file to perform the operation on.)

Second input XML file to perform the operation on.

False

inputFile3

file

(Third input XML file to perform the operation on.)

Third input XML file to perform the operation on.

False

inputFile4

file

(Fourth input XML file to perform the operation on.)

Fourth input XML file to perform the operation on.

False

inputFile5

file

(Fifth input XML file to perform the operation on.)

Fifth input XML file to perform the operation on.

False

inputFile6

file

(Sixth input XML file to perform the operation on.)

Sixth input XML file to perform the operation on.

False

inputFile7

file

(Seventh input XML file to perform the operation on.)

Seventh input XML file to perform the operation on.

False

inputFile8

file

(Eighth input XML file to perform the operation on.)

Eighth input XML file to perform the operation on.

False

inputFile9

file

(Ninth input XML file to perform the operation on.)

Ninth input XML file to perform the operation on.

False

inputFile10

file

(Tenth input XML file to perform the operation on.)

Tenth input XML file to perform the operation on.

False

XQuery

string

(Valid XML XQuery 3.1 or earlier query expression; multi-line expressio)

Valid XML XQuery 3.1 or earlier query expression; multi-line expressio

True

 

Returns:

          Type:XmlQueryWithXQueryMultiResult

          Description: Result of performing an XQuery operation on multiple XML documents.

 

ConvertData_XmlFilterWithXPath

Summary: Filter, select XML nodes using XPath expression, get results

Description: Return the reuslts of filtering, selecting an XML document with an XPath expression

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlFilterWithXPath (string XPathExpression, file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

XPathExpression

string

(Valid XML XPath query expression)

Valid XML XPath query expression

True

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:XmlFilterWithXPathResult

          Description: Result of performing a filter operation on XML input using XPath

 

ConvertData_XmlToJson

Summary: Convert XML to JSON conversion

Description: Convert an XML string or file into JSON

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlToJson (file inputFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input file to perform the operation on.)

Input file to perform the operation on.

True

 

Returns:

          Type:ConvertData_XmlToJsonResponse

 

ConvertData_XmlTransformWithXsltToXml

Summary: Transform XML document file with XSLT into a new XML document

Description: Convert an XML string or file into JSON

 

Syntax:

CloudmersiveDocumentConversion.ConvertData_XmlTransformWithXsltToXml (file inputFile, file transformFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

inputFile

file

(Input XML file to perform the operation on.)

Input XML file to perform the operation on.

True

transformFile

file

(Input XSLT file to use to transform the input XML file.)

Input XSLT file to use to transform the input XML file.

True

 

Returns:

          Type:string(byte)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 


 

AlternateFileFormatCandidate

Summary:

Description: Alternate file format possibility

 

          Properties:

Name

Type

Summary

DetectedFileExtension

string

 

Detected file extension of the file format, with a leading period

DetectedMimeType

string

 

MIME type of this file extension

Probability

number(double)

 

Probability that this extension is the right one; possible values are between 0.0 (lowest confidence) and 1.0 (highest confidence)


 

AutodetectDocumentValidationResult

Summary:

Description: Document validation result

 

          Properties:

Name

Type

Summary

DocumentIsValid

boolean

 

True if the document is valid and has no errors, false otherwise

ErrorCount

integer(int32)

 

Number of validation errors found in the document

ErrorsAndWarnings

array of (DocumentValidationError)

 

Details of errors and warnings found

FileFormatExtension

string

 

 

WarningCount

integer(int32)

 

Number of validation warnings found in the document


 

AutodetectGetInfoResult

Summary:

Description: Result of an autodetect/get-info operation

 

          Properties:

Name

Type

Summary

AlternateFileTypeCandidates

array of (AlternateFileFormatCandidate)

 

Alternate file type options and their probability

Author

string

 

User name of the creator/author of the document, if available, null if not available

DateModified

string(date-time)

 

The timestamp that the document was last modified, if available, null if not available

DetectedFileExtension

string

 

Detected file extension of the file format, with a leading period

DetectedMimeType

string

 

MIME type of this file extension

PageCount

integer(int64)

 

Number of pages in a page-based document; for presentations, this is the number of slides and for a spreadsheet this is the number of worksheets.  Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image)

Successful

boolean

 

True if the operation was successful, false otherwise


 

AutodetectToPngResult

Summary:

Description: Result of converting an autodetected input to a PNG array

 

          Properties:

Name

Type

Summary

PngResultPages

array of (ConvertedPngPage)

 

Array of converted pages

Successful

boolean

 

True if the operation was successful, false otherwise


 

ClearXlsxCellRequest

Summary:

Description: Input to a Clear Cell in XLSX Worksheet request

 

          Properties:

Name

Type

Summary

CellIndex

integer(int32)

 

0-based index of the cell, 0, 1, 2, ... in the row to clear

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

RowIndex

integer(int32)

 

0-based index of the row, 0, 1, 2, ... to clear

WorksheetToUpdate

XlsxWorksheet

 

A worksheet (tab) in an Excel (XLSX) spreadsheet


 

ClearXlsxCellResponse

Summary:

Description: Result of running a Clear XLSX Cell command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

ConvertData_CsvToJsonResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ConvertData_JsonToXmlParameterJsonObject

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ConvertData_XlsToJsonResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ConvertData_XlsxToJsonResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ConvertData_XmlToJsonResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ConvertedPngPage

Summary:

Description: A single converted page

 

          Properties:

Name

Type

Summary

PageNumber

integer(int32)

 

Page number of the converted page, starting with 1

URL

string

 

URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted


 

ConvertWeb_HtmlToPngResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateBlankDocxRequest

Summary:

Description: Input to a Create Blank Word Document request

 

          Properties:

Name

Type

Summary

InitialText

string

 

Optional; initial text to include in the document


 

CreateBlankDocxResponse

Summary:

Description: Result of creating a blank Word document

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

CreateBlankSpreadsheetRequest

Summary:

Description: Input to a Create Blank Spreadsheet request

 

          Properties:

Name

Type

Summary

WorksheetName

string

 

The blank Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1


 

CreateBlankSpreadsheetResponse

Summary:

Description: Result of creating a blank worksheet

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

CreateSpreadsheetFromDataRequest

Summary:

Description: Input to Create a new Spreadsheet request

 

          Properties:

Name

Type

Summary

Rows

array of (XlsxSpreadsheetRow)

 

Required; Rows and cells to populate the spreadsheet with

WorksheetName

string

 

Optional; The new Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1


 

CreateSpreadsheetFromDataResponse

Summary:

Description: Result of creating a new worksheet from rows and cells

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DeleteDocxTableRowRangeRequest

Summary:

Description: Input to a delete DOCX table row range request

 

          Properties:

Name

Type

Summary

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

TablePath

string

 

Path to the table to delete the row from

TableRowRowIndexEnd

integer(int32)

 

0-based index of the row to stop deleting rows (e.g. 0, 1, 2, ...) in the table

TableRowRowIndexStart

integer(int32)

 

0-based index of the row to begin deleting rows (e.g. 0, 1, 2, ...) in the table


 

DeleteDocxTableRowRangeResponse

Summary:

Description: Result of running an Delete Table Row Range command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DeleteDocxTableRowRequest

Summary:

Description: Input to a delete DOCX table row request

 

          Properties:

Name

Type

Summary

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

TablePath

string

 

Path to the table to delete the row from

TableRowRowIndex

integer(int32)

 

0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table


 

DeleteDocxTableRowResponse

Summary:

Description: Result of running an Delete Table Row command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DocumentValidationError

Summary:

Description: Validation error found in document

 

          Properties:

Name

Type

Summary

Description

string

 

Description of the error

IsError

boolean

 

True if this is an error, false otherwise

Path

string

 

XPath to the error

Uri

string

 

URI of the part in question


 

DocumentValidationResult

Summary:

Description: Document validation result

 

          Properties:

Name

Type

Summary

DocumentIsValid

boolean

 

True if the document is valid and has no errors, false otherwise

ErrorCount

integer(int32)

 

Number of validation errors found in the document

ErrorsAndWarnings

array of (DocumentValidationError)

 

Details of errors and warnings found

WarningCount

integer(int32)

 

Number of validation warnings found in the document


 

DocxBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

AllParagraphs

array of (DocxParagraph)

 

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document

AllTables

array of (DocxTable)

 

All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document

Path

string

 

The Path of the location of this object; leave blank for new tables


 

DocxCellStyle

Summary:

Description: Style in an Excel spreadsheet

 

          Properties:

Name

Type

Summary

BuiltInID

integer(int32)

 

Built=in ID of the cell style

FormatID

integer(int32)

 

Format ID of the cell style

Name

string

 

Name of the style

Path

string

 

The Path of the location of this object; leave blank for new rows


 

DocxComment

Summary:

Description: Comment in a Word Document

 

          Properties:

Name

Type

Summary

Author

string

 

Author name of the comment

AuthorInitials

string

 

Initials of the author of the comment

CommentDate

string(date-time)

 

Date timestamp of the comment

CommentText

string

 

Text content of the comment

Done

boolean

 

True if this comment is marked as Done in Word, otherwise it is false

IsReply

boolean

 

True if this comment is a reply to another comment, false otherwise

IsTopLevel

boolean

 

True if the comment is at the top level, false if this comment is a child reply of another comment

ParentCommentPath

string

 

Path to the parent of this comment, if this comment is a reply, otherwise this value will be null

Path

string

 

Path to the comment in the document


 

DocxFooter

Summary:

Description: Footer in a Word Document (DOCX)

 

          Properties:

Name

Type

Summary

Paragraphs

array of (DocxParagraph)

 

Paragraphs in this footer

Path

string

 

The Path of the location of this object; leave blank for new tables

SectionsWithFooter

array of (DocxSection)

 

Sections that the footer is applied to


 

DocxHeader

Summary:

Description: Header of a Word Document (DOCX)

 

          Properties:

Name

Type

Summary

Paragraphs

array of (DocxParagraph)

 

Paragraphs in this header

Path

string

 

The Path of the location of this object; leave blank for new tables

SectionsWithHeader

array of (DocxSection)

 

Sections that the header is applied to


 

DocxImage

Summary:

Description:

 

          Properties:

Name

Type

Summary

ImageContentsURL

string

 

URL to the image contents; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the contents.

ImageDataContentType

string

 

Read-only; image data MIME content-type

ImageDataEmbedId

string

 

Read-only; internal ID for the image contents

ImageDescription

string

 

The Description of the image

ImageHeight

integer(int64)

 

Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

ImageId

integer(int64)

 

The Id of the image

ImageInternalFileName

string

 

Read-only; internal file name/path for the image

ImageName

string

 

The Name of the image

ImageWidth

integer(int64)

 

Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height

InlineWithText

boolean

 

True if the image is inline with the text; false if it is floating

Path

string

 

The Path of the location of this object; leave blank for new tables

XOffset

integer(int64)

 

X (horizontal) offset of the image

YOffset

integer(int64)

 

Y (vertical) offset of the image


 

DocxInsertCommentOnParagraphRequest

Summary:

Description: Input to a Insert Comment on Paragraph request

 

          Properties:

Name

Type

Summary

CommentToInsert

DocxComment

 

Comment in a Word Document

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

ParagraphPath

string

 

Path to the paragraph to attach the comment to.  You can get the Path by retrieving all of the Paragraphs in document by calling Get Body and taking the Path property of the desired paragraph to add the comment to.


 

DocxInsertImageRequest

Summary:

Description: Input to set-footer command

 

          Properties:

Name

Type

Summary

HeightInEMUs

integer(int64)

 

Optional: The height of the image in EMUs

ImageToAdd

DocxImage

 

 

InputDocumentFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputDocumentFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

InputImageFileBytes

string(byte)

 

Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.

InputImageFileUrl

string

 

Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

InsertPath

string

 

Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.  Used with InsertPlacement of BeforeExistingObject or AfterExistingObject

InsertPlacement

string

 

Optional; default is DocumentEnd.  Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)

WidthInEMUs

integer(int64)

 

Optional: The width of the image in EMUs


 

DocxInsertImageResponse

Summary:

Description: Result of running a set-footer command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DocxPage

Summary:

Description: One page in a Word Document DOCX

 

          Properties:

Name

Type

Summary

PageNumber

integer(int32)

 

Page number of this page, 1-based

Paragraphs

array of (DocxParagraph)

 

All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document


 

DocxParagraph

Summary:

Description: A paragraph in a Word Document (DOCX) file; there is where text, content and formatting are stored - similar to the paragraph tag in HTML

 

          Properties:

Name

Type

Summary

ContentRuns

array of (DocxRun)

 

The content runs in the paragraph - this is where text is stored; similar to a span in HTML

ParagraphIndex

integer(int32)

 

The index of the paragraph; 0-based

Path

string

 

The Path of the location of this object; leave blank for new tables

StyleID

string

 

Style ID of the style applied to the paragraph; null if no style is applied


 

DocxRemoveObjectRequest

Summary:

Description: Input to a Insert Paragraph request

 

          Properties:

Name

Type

Summary

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

PathToObjectToRemove

string

 

Path within the document of the object to delete; fill in the PathToObjectToRemove field using the Path value from an existing object.


 

DocxRemoveObjectResponse

Summary:

Description: Result of running an Remove-Object command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DocxRun

Summary:

Description: A content run in a Word Document (DOCX) file

 

          Properties:

Name

Type

Summary

Bold

boolean

 

True to make the text bold, false otherwise

FontFamily

string

 

Font Family name for the text, e.g. "Arial" or "Times New Roman"

FontSize

string

 

Font size in font points (e.g. "24")

Italic

boolean

 

True to make the text italic, false otherwise

Path

string

 

The Path of the location of this object; leave blank for new tables

RunIndex

integer(int32)

 

Index of the run, 0-based

TextItems

array of (DocxText)

 

Text items inside the run; this is where the actual text content is stored

Underline

string

 

Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None


 

DocxSection

Summary:

Description: Section of a Word Document (DOCX)

 

          Properties:

Name

Type

Summary

Path

string

 

The Path of the location of this object; leave blank for new tables

StartingPageNumbers

array of (integer(int32))

 

Page numbers that the section starts at, typically just one


 

DocxSetFooterAddPageNumberRequest

Summary:

Description: Input to set-footer/add-page-number command

 

          Properties:

Name

Type

Summary

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).

PrependText

string

 

Optional: extra text to add before the page number, for example if you want to show "Page 1" then you can set PrependText to "Page"


 

DocxSetFooterRequest

Summary:

Description: Input to set-footer command

 

          Properties:

Name

Type

Summary

FooterToApply

DocxFooter

 

Footer in a Word Document (DOCX)

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).


 

DocxSetFooterResponse

Summary:

Description: Result of running a set-footer command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DocxSetHeaderRequest

Summary:

Description: Input to a set-header command

 

          Properties:

Name

Type

Summary

HeaderToApply

DocxHeader

 

Header of a Word Document (DOCX)

InputFileBytes

string(byte)

 

Optional: Bytes of the input file to operate on

InputFileUrl

string

 

Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).


 

DocxSetHeaderResponse

Summary:

Description: Result of running a set-header command

 

          Properties:

Name

Type

Summary

EditedDocumentURL

string

 

URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.

Successful

boolean

 

True if successful, false otherwise


 

DocxStyle

Summary:

Description: Style in a DOCX Word Document

 

          Properties:

Name

Type

Summary

Bold

boolean

 

Style applies bold formatting

FontFamily

string

 

Font family

FontSize

string

 

Font size

Italic

boolean

 

Style applies italic formatting

Path

string

 

The Path of the location of this object; leave blank for new tables

StyleID

string

 

ID of the style

Underline

boolean

 

Style applies underline formatting


 

DocxTable

Summary:

Description: A table in a Word Document (DOCX) file

 

          Properties:

Name

Type

Summary

BottomBorderColor

string

 

HTML-style color hex value (do not include a #)

BottomBorderSize

integer(int32)

 

Width of the border in points (1/72nd of an inch)

BottomBorderSpace

integer(int32)

 

Spacing around the border in points (1/72nd of an inch)

BottomBorderType

string

 

Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellHorizontalBorderColor

string

 

HTML-style color hex value (do not include a #)

CellHorizontalBorderSize

integer(int32)

 

Width of the border in points (1/72nd of an inch)

CellHorizontalBorderSpace

integer(int32)

 

Spacing around the border in points (1/72nd of an inch)

CellHorizontalBorderType

string

 

Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

CellVerticalBorderColor

string

 

HTML-style color hex value (do not include a #)

CellVerticalBorderSize

integer(int32)

 

Width of the border in points (1/72nd of an inch)

CellVerticalBorderSpace

integer(int32)

 

Spacing around the border in points (1/72nd of an inch)

CellVerticalBorderType

string

 

Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave

EndBorderColor

string

 

HTML-style color hex value (do not include a #)

EndBorderSize

integer(int32)

 

Width of the border in points (1/72nd of an inch)

EndBorderSpace

integer(int32)

 

Spacing around the border in points (1/72nd of an inch)

EndBorderType

string