WordsApi class
Aspose.Words for Cloud API.
Constructors
- WordsApi.new(Configuration configuration)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
acceptAllRevisions(
AcceptAllRevisionsRequest request) → Future< RevisionsModificationResponse> - Accepts all revisions in the document.
-
acceptAllRevisionsOnline(
AcceptAllRevisionsOnlineRequest request) → Future< AcceptAllRevisionsOnlineResponse> - Accepts all revisions in the document.
-
appendDocument(
AppendDocumentRequest request) → Future< DocumentResponse> - Appends documents to the original document.
-
appendDocumentOnline(
AppendDocumentOnlineRequest request) → Future< AppendDocumentOnlineResponse> - Appends documents to the original document.
-
applyStyleToDocumentElement(
ApplyStyleToDocumentElementRequest request) → Future< WordsResponse> - Applies a style to the document node.
-
applyStyleToDocumentElementOnline(
ApplyStyleToDocumentElementOnlineRequest request) → Future< ApplyStyleToDocumentElementOnlineResponse> - Applies a style to the document node.
-
batch(
List< BatchRequest> requests, {bool displayIntermediateResults = true}) → Future<List> -
buildReport(
BuildReportRequest request) → Future< DocumentResponse> - Executes the report generation process using the specified document template and the external data source in XML, JSON or CSV format.
-
buildReportOnline(
BuildReportOnlineRequest request) → Future< ByteData> - Executes the report generation process online using the specified document template and the external data source in XML, JSON or CSV format.
-
classify(
ClassifyRequest request) → Future< ClassificationResponse> - Runs a multi-class text classification for the specified raw text.
-
classifyDocument(
ClassifyDocumentRequest request) → Future< ClassificationResponse> - Runs a multi-class text classification for the document.
-
classifyDocumentOnline(
ClassifyDocumentOnlineRequest request) → Future< ClassificationResponse> - Runs a multi-class text classification for the document.
-
compareDocument(
CompareDocumentRequest request) → Future< DocumentResponse> - Compares two documents.
-
compareDocumentOnline(
CompareDocumentOnlineRequest request) → Future< CompareDocumentOnlineResponse> - Compares two documents.
-
compressDocument(
CompressDocumentRequest request) → Future< CompressResponse> - Compress and resize images inside the document. The default settings allows to reduce the size of the document without any visible degradation of images quality.
-
compressDocumentOnline(
CompressDocumentOnlineRequest request) → Future< CompressDocumentOnlineResponse> - Compress and resize images inside the document. The default settings allows to reduce the size of the document without any visible degradation of images quality.
-
convertDocument(
ConvertDocumentRequest request) → Future< ByteData> - Converts a document on a local drive to the specified format.
-
copyFile(
CopyFileRequest request) → Future< void> - Copy file.
-
copyFolder(
CopyFolderRequest request) → Future< void> - Copy folder.
-
copyStyle(
CopyStyleRequest request) → Future< StyleResponse> - Makes a copy of the style in the document.
-
copyStyleOnline(
CopyStyleOnlineRequest request) → Future< CopyStyleOnlineResponse> - Makes a copy of the style in the document.
-
copyStylesFromTemplate(
CopyStylesFromTemplateRequest request) → Future< WordsResponse> - Copies styles from the origin document to the target document.
-
createDocument(
CreateDocumentRequest request) → Future< DocumentResponse> - Creates a new document in cloud storage in the format, determined by the file extension. Supported all save format extensions.
-
createFolder(
CreateFolderRequest request) → Future< void> - Create the folder.
-
createOrUpdateDocumentProperty(
CreateOrUpdateDocumentPropertyRequest request) → Future< DocumentPropertyResponse> - Adds a new or updates an existing document property.
-
createOrUpdateDocumentPropertyOnline(
CreateOrUpdateDocumentPropertyOnlineRequest request) → Future< CreateOrUpdateDocumentPropertyOnlineResponse> - Adds a new or updates an existing document property.
-
deleteAllParagraphTabStops(
DeleteAllParagraphTabStopsRequest request) → Future< TabStopsResponse> - Removes paragraph tab stops from the document node.
-
deleteAllParagraphTabStopsOnline(
DeleteAllParagraphTabStopsOnlineRequest request) → Future< DeleteAllParagraphTabStopsOnlineResponse> - Removes paragraph tab stops from the document node.
-
deleteBookmark(
DeleteBookmarkRequest request) → Future< void> - Removes a bookmark from the document.
-
deleteBookmarkOnline(
DeleteBookmarkOnlineRequest request) → Future< Map< String, ByteData> > - Removes a bookmark from the document.
-
deleteBookmarks(
DeleteBookmarksRequest request) → Future< void> - Removes all bookmarks from the document.
-
deleteBookmarksOnline(
DeleteBookmarksOnlineRequest request) → Future< Map< String, ByteData> > - Removes all bookmarks from the document.
-
deleteBorder(
DeleteBorderRequest request) → Future< BorderResponse> - Removes a border from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
deleteBorderOnline(
DeleteBorderOnlineRequest request) → Future< DeleteBorderOnlineResponse> - Removes a border from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
deleteBorders(
DeleteBordersRequest request) → Future< BordersResponse> - Removes borders from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
deleteBordersOnline(
DeleteBordersOnlineRequest request) → Future< DeleteBordersOnlineResponse> - Removes borders from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
deleteComment(
DeleteCommentRequest request) → Future< void> - Removes a comment from the document.
-
deleteCommentOnline(
DeleteCommentOnlineRequest request) → Future< Map< String, ByteData> > - Removes a comment from the document.
-
deleteComments(
DeleteCommentsRequest request) → Future< void> - Removes all comments from the document.
-
deleteCommentsOnline(
DeleteCommentsOnlineRequest request) → Future< Map< String, ByteData> > - Removes all comments from the document.
-
deleteCustomXmlPart(
DeleteCustomXmlPartRequest request) → Future< void> - Removes the custom xml part from the document.
-
deleteCustomXmlPartOnline(
DeleteCustomXmlPartOnlineRequest request) → Future< Map< String, ByteData> > - Removes the custom xml part from the document.
-
deleteCustomXmlParts(
DeleteCustomXmlPartsRequest request) → Future< void> - Removes all custom xml parts from the document.
-
deleteCustomXmlPartsOnline(
DeleteCustomXmlPartsOnlineRequest request) → Future< Map< String, ByteData> > - Removes all custom xml parts from the document.
-
deleteDocumentProperty(
DeleteDocumentPropertyRequest request) → Future< void> - Removes a document property.
-
deleteDocumentPropertyOnline(
DeleteDocumentPropertyOnlineRequest request) → Future< Map< String, ByteData> > - Removes a document property.
-
deleteDrawingObject(
DeleteDrawingObjectRequest request) → Future< void> - Removes a DrawingObject from the document node.
-
deleteDrawingObjectOnline(
DeleteDrawingObjectOnlineRequest request) → Future< Map< String, ByteData> > - Removes a DrawingObject from the document node.
-
deleteField(
DeleteFieldRequest request) → Future< void> - Removes a field from the document node.
-
deleteFieldOnline(
DeleteFieldOnlineRequest request) → Future< Map< String, ByteData> > - Removes a field from the document node.
-
deleteFields(
DeleteFieldsRequest request) → Future< void> - Removes fields from the document node.
-
deleteFieldsOnline(
DeleteFieldsOnlineRequest request) → Future< Map< String, ByteData> > - Removes fields from the document node.
-
deleteFile(
DeleteFileRequest request) → Future< void> - Delete file.
-
deleteFolder(
DeleteFolderRequest request) → Future< void> - Delete folder.
-
deleteFootnote(
DeleteFootnoteRequest request) → Future< void> - Removes a footnote from the document node.
-
deleteFootnoteOnline(
DeleteFootnoteOnlineRequest request) → Future< Map< String, ByteData> > - Removes a footnote from the document node.
-
deleteFormField(
DeleteFormFieldRequest request) → Future< void> - Removes a form field from the document node.
-
deleteFormFieldOnline(
DeleteFormFieldOnlineRequest request) → Future< Map< String, ByteData> > - Removes a form field from the document node.
- Removes a HeaderFooter object from the document section.
- Removes a HeaderFooter object from the document section.
- Removes HeaderFooter objects from the document section.
- Removes HeaderFooter objects from the document section.
-
deleteMacros(
DeleteMacrosRequest request) → Future< void> - Removes macros from the document.
-
deleteMacrosOnline(
DeleteMacrosOnlineRequest request) → Future< Map< String, ByteData> > - Removes macros from the document.
-
deleteOfficeMathObject(
DeleteOfficeMathObjectRequest request) → Future< void> - Removes an OfficeMath object from the document node.
-
deleteOfficeMathObjectOnline(
DeleteOfficeMathObjectOnlineRequest request) → Future< Map< String, ByteData> > - Removes an OfficeMath object from the document node.
-
deleteOfficeMathObjects(
DeleteOfficeMathObjectsRequest request) → Future< void> - Removes all office math objects from the document.
-
deleteOfficeMathObjectsOnline(
DeleteOfficeMathObjectsOnlineRequest request) → Future< Map< String, ByteData> > - Removes all office math objects from the document.
-
deleteParagraph(
DeleteParagraphRequest request) → Future< void> - Removes a paragraph from the document node.
-
deleteParagraphListFormat(
DeleteParagraphListFormatRequest request) → Future< ParagraphListFormatResponse> - Removes the formatting properties of a paragraph list from the document node.
-
deleteParagraphListFormatOnline(
DeleteParagraphListFormatOnlineRequest request) → Future< DeleteParagraphListFormatOnlineResponse> - Removes the formatting properties of a paragraph list from the document node.
-
deleteParagraphOnline(
DeleteParagraphOnlineRequest request) → Future< Map< String, ByteData> > - Removes a paragraph from the document node.
-
deleteParagraphTabStop(
DeleteParagraphTabStopRequest request) → Future< TabStopsResponse> - Removes a paragraph tab stop from the document node.
-
deleteParagraphTabStopOnline(
DeleteParagraphTabStopOnlineRequest request) → Future< DeleteParagraphTabStopOnlineResponse> - Removes a paragraph tab stop from the document node.
-
deleteRun(
DeleteRunRequest request) → Future< void> - Removes a Run object from the paragraph.
-
deleteRunOnline(
DeleteRunOnlineRequest request) → Future< Map< String, ByteData> > - Removes a Run object from the paragraph.
-
deleteSection(
DeleteSectionRequest request) → Future< void> - Removes a section from the document.
-
deleteSectionOnline(
DeleteSectionOnlineRequest request) → Future< Map< String, ByteData> > - Removes a section from the document.
-
deleteStructuredDocumentTag(
DeleteStructuredDocumentTagRequest request) → Future< void> - Removes a StructuredDocumentTag (SDT) from the document node.
-
deleteStructuredDocumentTagOnline(
DeleteStructuredDocumentTagOnlineRequest request) → Future< Map< String, ByteData> > - Removes a StructuredDocumentTag (SDT) from the document node.
-
deleteTable(
DeleteTableRequest request) → Future< void> - Removes a table from the document node.
-
deleteTableCell(
DeleteTableCellRequest request) → Future< void> - Removes a cell from the table row.
-
deleteTableCellOnline(
DeleteTableCellOnlineRequest request) → Future< Map< String, ByteData> > - Removes a cell from the table row.
-
deleteTableOnline(
DeleteTableOnlineRequest request) → Future< Map< String, ByteData> > - Removes a table from the document node.
-
deleteTableRow(
DeleteTableRowRequest request) → Future< void> - Removes a row from the table.
-
deleteTableRowOnline(
DeleteTableRowOnlineRequest request) → Future< Map< String, ByteData> > - Removes a row from the table.
-
deleteWatermark(
DeleteWatermarkRequest request) → Future< DocumentResponse> - Removes a watermark from the document.
-
deleteWatermarkOnline(
DeleteWatermarkOnlineRequest request) → Future< DeleteWatermarkOnlineResponse> - Removes a watermark from the document.
-
downloadFile(
DownloadFileRequest request) → Future< ByteData> - Download file.
-
encryptPassword(
String data) → Future< String> -
executeMailMerge(
ExecuteMailMergeRequest request) → Future< DocumentResponse> - Executes a Mail Merge operation.
-
executeMailMergeOnline(
ExecuteMailMergeOnlineRequest request) → Future< ByteData> - Executes a Mail Merge operation online.
-
getAllRevisions(
GetAllRevisionsRequest request) → Future< RevisionsResponse> - Get all information about revisions.
-
getAllRevisionsOnline(
GetAllRevisionsOnlineRequest request) → Future< RevisionsResponse> - Get all information about revisions.
-
getAvailableFonts(
GetAvailableFontsRequest request) → Future< AvailableFontsResponse> - Reads available fonts from the document.
-
getBookmarkByName(
GetBookmarkByNameRequest request) → Future< BookmarkResponse> - Reads a bookmark, specified by name, from the document.
-
getBookmarkByNameOnline(
GetBookmarkByNameOnlineRequest request) → Future< BookmarkResponse> - Reads a bookmark, specified by name, from the document.
-
getBookmarks(
GetBookmarksRequest request) → Future< BookmarksResponse> - Reads bookmarks from the document.
-
getBookmarksOnline(
GetBookmarksOnlineRequest request) → Future< BookmarksResponse> - Reads bookmarks from the document.
-
getBorder(
GetBorderRequest request) → Future< BorderResponse> - Reads a border from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
getBorderOnline(
GetBorderOnlineRequest request) → Future< BorderResponse> - Reads a border from the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
getBorders(
GetBordersRequest request) → Future< BordersResponse> - Reads borders from the document node.
-
getBordersOnline(
GetBordersOnlineRequest request) → Future< BordersResponse> - Reads borders from the document node.
-
getComment(
GetCommentRequest request) → Future< CommentResponse> - Reads a comment from the document.
-
getCommentOnline(
GetCommentOnlineRequest request) → Future< CommentResponse> - Reads a comment from the document.
-
getComments(
GetCommentsRequest request) → Future< CommentsResponse> - Reads comments from the document.
-
getCommentsOnline(
GetCommentsOnlineRequest request) → Future< CommentsResponse> - Reads comments from the document.
-
getCustomXmlPart(
GetCustomXmlPartRequest request) → Future< CustomXmlPartResponse> - Reads the custom xml part from the document.
-
getCustomXmlPartOnline(
GetCustomXmlPartOnlineRequest request) → Future< CustomXmlPartResponse> - Reads the custom xml part from the document.
-
getCustomXmlParts(
GetCustomXmlPartsRequest request) → Future< CustomXmlPartsResponse> - Reads custom xml parts from the document.
-
getCustomXmlPartsOnline(
GetCustomXmlPartsOnlineRequest request) → Future< CustomXmlPartsResponse> - Reads custom xml parts from the document.
-
getDocument(
GetDocumentRequest request) → Future< DocumentResponse> - Reads common information from the document.
-
getDocumentDrawingObjectByIndex(
GetDocumentDrawingObjectByIndexRequest request) → Future< DrawingObjectResponse> - Reads a DrawingObject from the document node.
-
getDocumentDrawingObjectByIndexOnline(
GetDocumentDrawingObjectByIndexOnlineRequest request) → Future< DrawingObjectResponse> - Reads a DrawingObject from the document node.
-
getDocumentDrawingObjectImageData(
GetDocumentDrawingObjectImageDataRequest request) → Future< ByteData> - Reads image data of a DrawingObject from the document node.
-
getDocumentDrawingObjectImageDataOnline(
GetDocumentDrawingObjectImageDataOnlineRequest request) → Future< ByteData> - Reads image data of a DrawingObject from the document node.
-
getDocumentDrawingObjectOleData(
GetDocumentDrawingObjectOleDataRequest request) → Future< ByteData> - Reads OLE data of a DrawingObject from the document node.
-
getDocumentDrawingObjectOleDataOnline(
GetDocumentDrawingObjectOleDataOnlineRequest request) → Future< ByteData> - Reads OLE data of a DrawingObject from the document node.
-
getDocumentDrawingObjects(
GetDocumentDrawingObjectsRequest request) → Future< DrawingObjectsResponse> - Reads DrawingObjects from the document node.
-
getDocumentDrawingObjectsOnline(
GetDocumentDrawingObjectsOnlineRequest request) → Future< DrawingObjectsResponse> - Reads DrawingObjects from the document node.
-
getDocumentFieldNames(
GetDocumentFieldNamesRequest request) → Future< FieldNamesResponse> - Reads merge field names from the document.
-
getDocumentFieldNamesOnline(
GetDocumentFieldNamesOnlineRequest request) → Future< FieldNamesResponse> - Reads merge field names from the document.
-
getDocumentHyperlinkByIndex(
GetDocumentHyperlinkByIndexRequest request) → Future< HyperlinkResponse> - Reads a hyperlink from the document.
-
getDocumentHyperlinkByIndexOnline(
GetDocumentHyperlinkByIndexOnlineRequest request) → Future< HyperlinkResponse> - Reads a hyperlink from the document.
-
getDocumentHyperlinks(
GetDocumentHyperlinksRequest request) → Future< HyperlinksResponse> - Reads hyperlinks from the document.
-
getDocumentHyperlinksOnline(
GetDocumentHyperlinksOnlineRequest request) → Future< HyperlinksResponse> - Reads hyperlinks from the document.
-
getDocumentProperties(
GetDocumentPropertiesRequest request) → Future< DocumentPropertiesResponse> - Reads document properties.
-
getDocumentPropertiesOnline(
GetDocumentPropertiesOnlineRequest request) → Future< DocumentPropertiesResponse> - Reads document properties.
-
getDocumentProperty(
GetDocumentPropertyRequest request) → Future< DocumentPropertyResponse> - Reads a document property.
-
getDocumentPropertyOnline(
GetDocumentPropertyOnlineRequest request) → Future< DocumentPropertyResponse> - Reads a document property.
-
getDocumentProtection(
GetDocumentProtectionRequest request) → Future< ProtectionDataResponse> - Reads protection properties from the document.
-
getDocumentProtectionOnline(
GetDocumentProtectionOnlineRequest request) → Future< ProtectionDataResponse> - Reads protection properties from the document.
-
getDocumentStatistics(
GetDocumentStatisticsRequest request) → Future< StatDataResponse> - Reads document statistics.
-
getDocumentStatisticsOnline(
GetDocumentStatisticsOnlineRequest request) → Future< StatDataResponse> - Reads document statistics.
-
getDocumentWithFormat(
GetDocumentWithFormatRequest request) → Future< ByteData> - Converts a document in cloud storage to the specified format.
-
getField(
GetFieldRequest request) → Future< FieldResponse> - Reads a field from the document node.
-
getFieldOnline(
GetFieldOnlineRequest request) → Future< FieldResponse> - Reads a field from the document node.
-
getFields(
GetFieldsRequest request) → Future< FieldsResponse> - Reads fields from the document node.
-
getFieldsOnline(
GetFieldsOnlineRequest request) → Future< FieldsResponse> - Reads fields from the document node.
-
getFilesList(
GetFilesListRequest request) → Future< FilesList> - Get all files and folders within a folder.
-
getFootnote(
GetFootnoteRequest request) → Future< FootnoteResponse> - Reads a footnote from the document node.
-
getFootnoteOnline(
GetFootnoteOnlineRequest request) → Future< FootnoteResponse> - Reads a footnote from the document node.
-
getFootnotes(
GetFootnotesRequest request) → Future< FootnotesResponse> - Reads footnotes from the document node.
-
getFootnotesOnline(
GetFootnotesOnlineRequest request) → Future< FootnotesResponse> - Reads footnotes from the document node.
-
getFormField(
GetFormFieldRequest request) → Future< FormFieldResponse> - Reads a form field from the document node.
-
getFormFieldOnline(
GetFormFieldOnlineRequest request) → Future< FormFieldResponse> - Reads a form field from the document node.
-
getFormFields(
GetFormFieldsRequest request) → Future< FormFieldsResponse> - Reads form fields from the document node.
-
getFormFieldsOnline(
GetFormFieldsOnlineRequest request) → Future< FormFieldsResponse> - Reads form fields from the document node.
- Reads a HeaderFooter object from the document.
- Reads a HeaderFooter object from the document section.
- Reads a HeaderFooter object from the document section.
- Reads a HeaderFooter object from the document.
- Reads HeaderFooter objects from the document section.
- Reads HeaderFooter objects from the document section.
-
getInfo(
GetInfoRequest request) → Future< InfoResponse> - Returns application info.
-
getList(
GetListRequest request) → Future< ListResponse> - Reads a list from the document.
-
getListOnline(
GetListOnlineRequest request) → Future< ListResponse> - Reads a list from the document.
-
getLists(
GetListsRequest request) → Future< ListsResponse> - Reads lists from the document.
-
getListsOnline(
GetListsOnlineRequest request) → Future< ListsResponse> - Reads lists from the document.
-
getOfficeMathObject(
GetOfficeMathObjectRequest request) → Future< OfficeMathObjectResponse> - Reads an OfficeMath object from the document node.
-
getOfficeMathObjectOnline(
GetOfficeMathObjectOnlineRequest request) → Future< OfficeMathObjectResponse> - Reads an OfficeMath object from the document node.
-
getOfficeMathObjects(
GetOfficeMathObjectsRequest request) → Future< OfficeMathObjectsResponse> - Reads OfficeMath objects from the document node.
-
getOfficeMathObjectsOnline(
GetOfficeMathObjectsOnlineRequest request) → Future< OfficeMathObjectsResponse> - Reads OfficeMath objects from the document node.
-
getParagraph(
GetParagraphRequest request) → Future< ParagraphResponse> - Reads a paragraph from the document node.
-
getParagraphFormat(
GetParagraphFormatRequest request) → Future< ParagraphFormatResponse> - Reads the formatting properties of a paragraph from the document node.
-
getParagraphFormatOnline(
GetParagraphFormatOnlineRequest request) → Future< ParagraphFormatResponse> - Reads the formatting properties of a paragraph from the document node.
-
getParagraphListFormat(
GetParagraphListFormatRequest request) → Future< ParagraphListFormatResponse> - Reads the formatting properties of a paragraph list from the document node.
-
getParagraphListFormatOnline(
GetParagraphListFormatOnlineRequest request) → Future< ParagraphListFormatResponse> - Reads the formatting properties of a paragraph list from the document node.
-
getParagraphOnline(
GetParagraphOnlineRequest request) → Future< ParagraphResponse> - Reads a paragraph from the document node.
-
getParagraphs(
GetParagraphsRequest request) → Future< ParagraphLinkCollectionResponse> - Reads paragraphs from the document node.
-
getParagraphsOnline(
GetParagraphsOnlineRequest request) → Future< ParagraphLinkCollectionResponse> - Reads paragraphs from the document node.
-
getParagraphTabStops(
GetParagraphTabStopsRequest request) → Future< TabStopsResponse> - Reads paragraph tab stops from the document node.
-
getParagraphTabStopsOnline(
GetParagraphTabStopsOnlineRequest request) → Future< TabStopsResponse> - Reads paragraph tab stops from the document node.
-
getPublicKey(
GetPublicKeyRequest request) → Future< PublicKeyResponse> - Get assymetric public key.
-
getRangeText(
GetRangeTextRequest request) → Future< RangeTextResponse> - Reads range text from the document.
-
getRangeTextOnline(
GetRangeTextOnlineRequest request) → Future< RangeTextResponse> - Reads range text from the document.
-
getRun(
GetRunRequest request) → Future< RunResponse> - Reads a Run object from the paragraph.
-
getRunFont(
GetRunFontRequest request) → Future< FontResponse> - Reads the font properties of a Run object from the paragraph.
-
getRunFontOnline(
GetRunFontOnlineRequest request) → Future< FontResponse> - Reads the font properties of a Run object from the paragraph.
-
getRunOnline(
GetRunOnlineRequest request) → Future< RunResponse> - Reads a Run object from the paragraph.
-
getRuns(
GetRunsRequest request) → Future< RunsResponse> - Reads Run objects from the paragraph.
-
getRunsOnline(
GetRunsOnlineRequest request) → Future< RunsResponse> - Reads Run objects from the paragraph.
-
getSection(
GetSectionRequest request) → Future< SectionResponse> - Reads a section from the document.
-
getSectionOnline(
GetSectionOnlineRequest request) → Future< SectionResponse> - Reads a section from the document.
-
getSectionPageSetup(
GetSectionPageSetupRequest request) → Future< SectionPageSetupResponse> - Reads the page setup of a section from the document.
-
getSectionPageSetupOnline(
GetSectionPageSetupOnlineRequest request) → Future< SectionPageSetupResponse> - Reads the page setup of a section from the document.
-
getSections(
GetSectionsRequest request) → Future< SectionLinkCollectionResponse> - Reads sections from the document.
-
getSectionsOnline(
GetSectionsOnlineRequest request) → Future< SectionLinkCollectionResponse> - Reads sections from the document.
-
getSignatures(
GetSignaturesRequest request) → Future< SignatureCollectionResponse> - Gets signatures from the document.
-
getSignaturesOnline(
GetSignaturesOnlineRequest request) → Future< SignatureCollectionResponse> - Gets signatures from the document.
-
getStructuredDocumentTag(
GetStructuredDocumentTagRequest request) → Future< StructuredDocumentTagResponse> - Reads a StructuredDocumentTag (SDT) from the document node.
-
getStructuredDocumentTagOnline(
GetStructuredDocumentTagOnlineRequest request) → Future< StructuredDocumentTagResponse> - Reads a StructuredDocumentTag (SDT) from the document node.
-
getStructuredDocumentTags(
GetStructuredDocumentTagsRequest request) → Future< StructuredDocumentTagsResponse> - Reads StructuredDocumentTags (SDT) from the document node.
-
getStructuredDocumentTagsOnline(
GetStructuredDocumentTagsOnlineRequest request) → Future< StructuredDocumentTagsResponse> - Reads StructuredDocumentTags (SDT) from the document node.
-
getStyle(
GetStyleRequest request) → Future< StyleResponse> - Reads a style from the document.
-
getStyleFromDocumentElement(
GetStyleFromDocumentElementRequest request) → Future< StyleResponse> - Reads a style from the document node.
-
getStyleFromDocumentElementOnline(
GetStyleFromDocumentElementOnlineRequest request) → Future< StyleResponse> - Reads a style from the document node.
-
getStyleOnline(
GetStyleOnlineRequest request) → Future< StyleResponse> - Reads a style from the document.
-
getStyles(
GetStylesRequest request) → Future< StylesResponse> - Reads styles from the document.
-
getStylesOnline(
GetStylesOnlineRequest request) → Future< StylesResponse> - Reads styles from the document.
-
getTable(
GetTableRequest request) → Future< TableResponse> - Reads a table from the document node.
-
getTableCell(
GetTableCellRequest request) → Future< TableCellResponse> - Reads a cell from the table row.
-
getTableCellFormat(
GetTableCellFormatRequest request) → Future< TableCellFormatResponse> - Reads the formatting properties of a table cell.
-
getTableCellFormatOnline(
GetTableCellFormatOnlineRequest request) → Future< TableCellFormatResponse> - Reads the formatting properties of a table cell.
-
getTableCellOnline(
GetTableCellOnlineRequest request) → Future< TableCellResponse> - Reads a cell from the table row.
-
getTableOnline(
GetTableOnlineRequest request) → Future< TableResponse> - Reads a table from the document node.
-
getTableProperties(
GetTablePropertiesRequest request) → Future< TablePropertiesResponse> - Reads properties of a table from the document node.
-
getTablePropertiesOnline(
GetTablePropertiesOnlineRequest request) → Future< TablePropertiesResponse> - Reads properties of a table from the document node.
-
getTableRow(
GetTableRowRequest request) → Future< TableRowResponse> - Reads a row from the table.
-
getTableRowFormat(
GetTableRowFormatRequest request) → Future< TableRowFormatResponse> - Reads the formatting properties of a table row.
-
getTableRowFormatOnline(
GetTableRowFormatOnlineRequest request) → Future< TableRowFormatResponse> - Reads the formatting properties of a table row.
-
getTableRowOnline(
GetTableRowOnlineRequest request) → Future< TableRowResponse> - Reads a row from the table.
-
getTables(
GetTablesRequest request) → Future< TableLinkCollectionResponse> - Reads tables from the document node.
-
getTablesOnline(
GetTablesOnlineRequest request) → Future< TableLinkCollectionResponse> - Reads tables from the document node.
-
insertBookmark(
InsertBookmarkRequest request) → Future< BookmarkResponse> - Inserts a new bookmark to the document.
-
insertBookmarkOnline(
InsertBookmarkOnlineRequest request) → Future< InsertBookmarkOnlineResponse> - Inserts a new bookmark to the document.
-
insertComment(
InsertCommentRequest request) → Future< CommentResponse> - Inserts a new comment to the document.
-
insertCommentOnline(
InsertCommentOnlineRequest request) → Future< InsertCommentOnlineResponse> - Inserts a new comment to the document.
-
insertCustomXmlPart(
InsertCustomXmlPartRequest request) → Future< CustomXmlPartResponse> - Inserts a new custom xml part to the document.
-
insertCustomXmlPartOnline(
InsertCustomXmlPartOnlineRequest request) → Future< InsertCustomXmlPartOnlineResponse> - Inserts a new custom xml part to the document.
-
insertDrawingObject(
InsertDrawingObjectRequest request) → Future< DrawingObjectResponse> - Inserts a new DrawingObject to the document node.
-
insertDrawingObjectOnline(
InsertDrawingObjectOnlineRequest request) → Future< InsertDrawingObjectOnlineResponse> - Inserts a new DrawingObject to the document node.
-
insertField(
InsertFieldRequest request) → Future< FieldResponse> - Inserts a new field to the document node.
-
insertFieldOnline(
InsertFieldOnlineRequest request) → Future< InsertFieldOnlineResponse> - Inserts a new field to the document node.
-
insertFootnote(
InsertFootnoteRequest request) → Future< FootnoteResponse> - Inserts a new footnote to the document node.
-
insertFootnoteOnline(
InsertFootnoteOnlineRequest request) → Future< InsertFootnoteOnlineResponse> - Inserts a new footnote to the document node.
-
insertFormField(
InsertFormFieldRequest request) → Future< FormFieldResponse> - Inserts a new form field to the document node.
-
insertFormFieldOnline(
InsertFormFieldOnlineRequest request) → Future< InsertFormFieldOnlineResponse> - Inserts a new form field to the document node.
- Inserts a new HeaderFooter object to the document section.
- Inserts a new HeaderFooter object to the document section.
-
insertList(
InsertListRequest request) → Future< ListResponse> - Inserts a new list to the document.
-
insertListOnline(
InsertListOnlineRequest request) → Future< InsertListOnlineResponse> - Inserts a new list to the document.
-
insertOrUpdateParagraphTabStop(
InsertOrUpdateParagraphTabStopRequest request) → Future< TabStopsResponse> - Inserts a new or updates an existing paragraph tab stop in the document node.
-
insertOrUpdateParagraphTabStopOnline(
InsertOrUpdateParagraphTabStopOnlineRequest request) → Future< InsertOrUpdateParagraphTabStopOnlineResponse> - Inserts a new or updates an existing paragraph tab stop in the document node.
-
insertPageNumbers(
InsertPageNumbersRequest request) → Future< DocumentResponse> - Inserts page numbers to the document.
-
insertPageNumbersOnline(
InsertPageNumbersOnlineRequest request) → Future< InsertPageNumbersOnlineResponse> - Inserts page numbers to the document.
-
insertParagraph(
InsertParagraphRequest request) → Future< ParagraphResponse> - Inserts a new paragraph to the document node.
-
insertParagraphOnline(
InsertParagraphOnlineRequest request) → Future< InsertParagraphOnlineResponse> - Inserts a new paragraph to the document node.
-
insertRun(
InsertRunRequest request) → Future< RunResponse> - Inserts a new Run object to the paragraph.
-
insertRunOnline(
InsertRunOnlineRequest request) → Future< InsertRunOnlineResponse> - Inserts a new Run object to the paragraph.
-
insertSection(
InsertSectionRequest request) → Future< void> - Inserts a section to the document.
-
insertSectionOnline(
InsertSectionOnlineRequest request) → Future< Map< String, ByteData> > - Inserts a section to the document.
-
insertStructuredDocumentTag(
InsertStructuredDocumentTagRequest request) → Future< StructuredDocumentTagResponse> - Inserts a new StructuredDocumentTag (SDT) to the document node.
-
insertStructuredDocumentTagOnline(
InsertStructuredDocumentTagOnlineRequest request) → Future< InsertStructuredDocumentTagOnlineResponse> - Inserts a new StructuredDocumentTag (SDT) to the document node.
-
insertStyle(
InsertStyleRequest request) → Future< StyleResponse> - Inserts a new style to the document.
-
insertStyleOnline(
InsertStyleOnlineRequest request) → Future< InsertStyleOnlineResponse> - Inserts a new style to the document.
-
insertTable(
InsertTableRequest request) → Future< TableResponse> - Inserts a new table to the document node.
-
insertTableCell(
InsertTableCellRequest request) → Future< TableCellResponse> - Inserts a new cell to the table row.
-
insertTableCellOnline(
InsertTableCellOnlineRequest request) → Future< InsertTableCellOnlineResponse> - Inserts a new cell to the table row.
-
insertTableOnline(
InsertTableOnlineRequest request) → Future< InsertTableOnlineResponse> - Inserts a new table to the document node.
-
insertTableRow(
InsertTableRowRequest request) → Future< TableRowResponse> - Inserts a new row to the table.
-
insertTableRowOnline(
InsertTableRowOnlineRequest request) → Future< InsertTableRowOnlineResponse> - Inserts a new row to the table.
-
insertWatermark(
InsertWatermarkRequest request) → Future< DocumentResponse> - Insert a watermark to the document.
-
insertWatermarkImage(
InsertWatermarkImageRequest request) → Future< DocumentResponse> - Inserts a new watermark image to the document.
-
insertWatermarkImageOnline(
InsertWatermarkImageOnlineRequest request) → Future< InsertWatermarkImageOnlineResponse> - Inserts a new watermark image to the document.
-
insertWatermarkOnline(
InsertWatermarkOnlineRequest request) → Future< InsertWatermarkOnlineResponse> - Insert a watermark to the document.
-
insertWatermarkText(
InsertWatermarkTextRequest request) → Future< DocumentResponse> - Inserts a new watermark text to the document.
-
insertWatermarkTextOnline(
InsertWatermarkTextOnlineRequest request) → Future< InsertWatermarkTextOnlineResponse> - Inserts a new watermark text to the document.
- Links headers / footers of the section to the previous one.
-
loadWebDocument(
LoadWebDocumentRequest request) → Future< SaveResponse> - Downloads a document from the Web using URL and saves it to cloud storage in the specified format.
-
mergeWithNext(
MergeWithNextRequest request) → Future< void> - Merge the section with the next one.
-
mergeWithNextOnline(
MergeWithNextOnlineRequest request) → Future< Map< String, ByteData> > - Merge the section with the next one.
-
moveFile(
MoveFileRequest request) → Future< void> - Move file.
-
moveFolder(
MoveFolderRequest request) → Future< void> - Move folder.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
optimizeDocument(
OptimizeDocumentRequest request) → Future< void> - Applies document content optimization options, specific to a particular versions of Microsoft Word.
-
optimizeDocumentOnline(
OptimizeDocumentOnlineRequest request) → Future< Map< String, ByteData> > - Applies document content optimization options, specific to a particular versions of Microsoft Word.
-
protectDocument(
ProtectDocumentRequest request) → Future< ProtectionDataResponse> - Changes the document protection. The previous protection will be overwritten if it exist.
-
protectDocumentOnline(
ProtectDocumentOnlineRequest request) → Future< ProtectDocumentOnlineResponse> - Changes the document protection. The previous protection will be overwritten if it exist.
-
rejectAllRevisions(
RejectAllRevisionsRequest request) → Future< RevisionsModificationResponse> - Rejects all revisions in the document.
-
rejectAllRevisionsOnline(
RejectAllRevisionsOnlineRequest request) → Future< RejectAllRevisionsOnlineResponse> - Rejects all revisions in the document.
-
removeAllSignatures(
RemoveAllSignaturesRequest request) → Future< SignatureCollectionResponse> - Removes all signatures of the document.
-
removeAllSignaturesOnline(
RemoveAllSignaturesOnlineRequest request) → Future< RemoveAllSignaturesOnlineResponse> - Removes all signatures of the document.
-
removeRange(
RemoveRangeRequest request) → Future< DocumentResponse> - Removes a range from the document.
-
removeRangeOnline(
RemoveRangeOnlineRequest request) → Future< RemoveRangeOnlineResponse> - Removes a range from the document.
-
renderDrawingObject(
RenderDrawingObjectRequest request) → Future< ByteData> - Renders a DrawingObject to the specified format.
-
renderDrawingObjectOnline(
RenderDrawingObjectOnlineRequest request) → Future< ByteData> - Renders a DrawingObject to the specified format.
-
renderMathObject(
RenderMathObjectRequest request) → Future< ByteData> - Renders an OfficeMath object to the specified format.
-
renderMathObjectOnline(
RenderMathObjectOnlineRequest request) → Future< ByteData> - Renders an OfficeMath object to the specified format.
-
renderPage(
RenderPageRequest request) → Future< ByteData> - Renders a page to the specified format.
-
renderPageOnline(
RenderPageOnlineRequest request) → Future< ByteData> - Renders a page to the specified format.
-
renderParagraph(
RenderParagraphRequest request) → Future< ByteData> - Renders a paragraph to the specified format.
-
renderParagraphOnline(
RenderParagraphOnlineRequest request) → Future< ByteData> - Renders a paragraph to the specified format.
-
renderTable(
RenderTableRequest request) → Future< ByteData> - Renders a table to the specified format.
-
renderTableOnline(
RenderTableOnlineRequest request) → Future< ByteData> - Renders a table to the specified format.
-
replaceText(
ReplaceTextRequest request) → Future< ReplaceTextResponse> - Replaces text in the document.
-
replaceTextOnline(
ReplaceTextOnlineRequest request) → Future< ReplaceTextOnlineResponse> - Replaces text in the document.
-
replaceWithText(
ReplaceWithTextRequest request) → Future< DocumentResponse> - Replaces a range with text in the document.
-
replaceWithTextOnline(
ReplaceWithTextOnlineRequest request) → Future< ReplaceWithTextOnlineResponse> - Replaces a range with text in the document.
-
resetCache(
ResetCacheRequest request) → Future< void> - Clears the font cache.
-
saveAs(
SaveAsRequest request) → Future< SaveResponse> - Converts a document in cloud storage to the specified format.
-
saveAsOnline(
SaveAsOnlineRequest request) → Future< SaveAsOnlineResponse> - Converts a document in cloud storage to the specified format.
-
saveAsRange(
SaveAsRangeRequest request) → Future< DocumentResponse> - Saves a range as a new document.
-
saveAsRangeOnline(
SaveAsRangeOnlineRequest request) → Future< SaveAsRangeOnlineResponse> - Saves a range as a new document.
-
saveAsTiff(
SaveAsTiffRequest request) → Future< SaveResponse> - Converts a document in cloud storage to TIFF format using detailed conversion settings.
-
saveAsTiffOnline(
SaveAsTiffOnlineRequest request) → Future< SaveAsTiffOnlineResponse> - Converts a document in cloud storage to TIFF format using detailed conversion settings.
-
search(
SearchRequest request) → Future< SearchResponse> - Searches text, specified by the regular expression, in the document.
-
searchOnline(
SearchOnlineRequest request) → Future< SearchResponse> - Searches text, specified by the regular expression, in the document.
-
signDocument(
SignDocumentRequest request) → Future< SignatureCollectionResponse> - Signs the document with given certificate.
-
signDocumentOnline(
SignDocumentOnlineRequest request) → Future< SignDocumentOnlineResponse> - Signs the document with given certificate.
-
splitDocument(
SplitDocumentRequest request) → Future< SplitDocumentResponse> - Splits a document into parts and saves them in the specified format.
-
splitDocumentOnline(
SplitDocumentOnlineRequest request) → Future< SplitDocumentOnlineResponse> - Splits a document into parts and saves them in the specified format.
-
toString(
) → String -
A string representation of this object.
inherited
-
translateNodeId(
TranslateNodeIdRequest request) → Future< TranslateNodeIdResponse> - Translate a node id to a node path.
-
translateNodeIdOnline(
TranslateNodeIdOnlineRequest request) → Future< TranslateNodeIdResponse> - Translate a node id to a node path.
-
unprotectDocument(
UnprotectDocumentRequest request) → Future< ProtectionDataResponse> - Removes protection from the document.
-
unprotectDocumentOnline(
UnprotectDocumentOnlineRequest request) → Future< UnprotectDocumentOnlineResponse> - Removes protection from the document.
-
updateBookmark(
UpdateBookmarkRequest request) → Future< BookmarkResponse> - Updates a bookmark in the document.
-
updateBookmarkOnline(
UpdateBookmarkOnlineRequest request) → Future< UpdateBookmarkOnlineResponse> - Updates a bookmark in the document.
-
updateBorder(
UpdateBorderRequest request) → Future< BorderResponse> - Updates a border in the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
updateBorderOnline(
UpdateBorderOnlineRequest request) → Future< UpdateBorderOnlineResponse> - Updates a border in the document node. The 'nodePath' parameter should refer to a paragraph, a cell or a row.
-
updateComment(
UpdateCommentRequest request) → Future< CommentResponse> - Updates a comment in the document.
-
updateCommentOnline(
UpdateCommentOnlineRequest request) → Future< UpdateCommentOnlineResponse> - Updates a comment in the document.
-
updateCustomXmlPart(
UpdateCustomXmlPartRequest request) → Future< CustomXmlPartResponse> - Updates the custom xml part in the document.
-
updateCustomXmlPartOnline(
UpdateCustomXmlPartOnlineRequest request) → Future< UpdateCustomXmlPartOnlineResponse> - Updates the custom xml part in the document.
-
updateDrawingObject(
UpdateDrawingObjectRequest request) → Future< DrawingObjectResponse> - Updates a DrawingObject in the document node.
-
updateDrawingObjectOnline(
UpdateDrawingObjectOnlineRequest request) → Future< UpdateDrawingObjectOnlineResponse> - Updates a DrawingObject in the document node.
-
updateField(
UpdateFieldRequest request) → Future< FieldResponse> - Updates a field in the document node.
-
updateFieldOnline(
UpdateFieldOnlineRequest request) → Future< UpdateFieldOnlineResponse> - Updates a field in the document node.
-
updateFields(
UpdateFieldsRequest request) → Future< DocumentResponse> - Reevaluates field values in the document.
-
updateFieldsOnline(
UpdateFieldsOnlineRequest request) → Future< UpdateFieldsOnlineResponse> - Reevaluates field values in the document.
-
updateFootnote(
UpdateFootnoteRequest request) → Future< FootnoteResponse> - Updates a footnote in the document node.
-
updateFootnoteOnline(
UpdateFootnoteOnlineRequest request) → Future< UpdateFootnoteOnlineResponse> - Updates a footnote in the document node.
-
updateFormField(
UpdateFormFieldRequest request) → Future< FormFieldResponse> - Updates a form field in the document node.
-
updateFormFieldOnline(
UpdateFormFieldOnlineRequest request) → Future< UpdateFormFieldOnlineResponse> - Updates a form field in the document node.
-
updateList(
UpdateListRequest request) → Future< ListResponse> - Updates a list in the document.
-
updateListLevel(
UpdateListLevelRequest request) → Future< ListResponse> - Updates the level of a List element in the document.
-
updateListLevelOnline(
UpdateListLevelOnlineRequest request) → Future< UpdateListLevelOnlineResponse> - Updates the level of a List element in the document.
-
updateListOnline(
UpdateListOnlineRequest request) → Future< UpdateListOnlineResponse> - Updates a list in the document.
-
updateParagraphFormat(
UpdateParagraphFormatRequest request) → Future< ParagraphFormatResponse> - Updates the formatting properties of a paragraph in the document node.
-
updateParagraphFormatOnline(
UpdateParagraphFormatOnlineRequest request) → Future< UpdateParagraphFormatOnlineResponse> - Updates the formatting properties of a paragraph in the document node.
-
updateParagraphListFormat(
UpdateParagraphListFormatRequest request) → Future< ParagraphListFormatResponse> - Updates the formatting properties of a paragraph list in the document node.
-
updateParagraphListFormatOnline(
UpdateParagraphListFormatOnlineRequest request) → Future< UpdateParagraphListFormatOnlineResponse> - Updates the formatting properties of a paragraph list in the document node.
-
updateRun(
UpdateRunRequest request) → Future< RunResponse> - Updates a Run object in the paragraph.
-
updateRunFont(
UpdateRunFontRequest request) → Future< FontResponse> - Updates the font properties of a Run object in the paragraph.
-
updateRunFontOnline(
UpdateRunFontOnlineRequest request) → Future< UpdateRunFontOnlineResponse> - Updates the font properties of a Run object in the paragraph.
-
updateRunOnline(
UpdateRunOnlineRequest request) → Future< UpdateRunOnlineResponse> - Updates a Run object in the paragraph.
-
updateSectionPageSetup(
UpdateSectionPageSetupRequest request) → Future< SectionPageSetupResponse> - Updates the page setup of a section in the document.
-
updateSectionPageSetupOnline(
UpdateSectionPageSetupOnlineRequest request) → Future< UpdateSectionPageSetupOnlineResponse> - Updates the page setup of a section in the document.
-
updateStructuredDocumentTag(
UpdateStructuredDocumentTagRequest request) → Future< StructuredDocumentTagResponse> - Updates a StructuredDocumentTag (SDT) in the document node.
-
updateStructuredDocumentTagOnline(
UpdateStructuredDocumentTagOnlineRequest request) → Future< UpdateStructuredDocumentTagOnlineResponse> - Updates a StructuredDocumentTag (SDT) in the document node.
-
updateStyle(
UpdateStyleRequest request) → Future< StyleResponse> - Updates a style in the document.
-
updateStyleOnline(
UpdateStyleOnlineRequest request) → Future< UpdateStyleOnlineResponse> - Updates a style in the document.
-
updateTableCellFormat(
UpdateTableCellFormatRequest request) → Future< TableCellFormatResponse> - Updates the formatting properties of a cell in the table row.
-
updateTableCellFormatOnline(
UpdateTableCellFormatOnlineRequest request) → Future< UpdateTableCellFormatOnlineResponse> - Updates the formatting properties of a cell in the table row.
-
updateTableProperties(
UpdateTablePropertiesRequest request) → Future< TablePropertiesResponse> - Updates properties of a table in the document node.
-
updateTablePropertiesOnline(
UpdateTablePropertiesOnlineRequest request) → Future< UpdateTablePropertiesOnlineResponse> - Updates properties of a table in the document node.
-
updateTableRowFormat(
UpdateTableRowFormatRequest request) → Future< TableRowFormatResponse> - Updates the formatting properties of a table row.
-
updateTableRowFormatOnline(
UpdateTableRowFormatOnlineRequest request) → Future< UpdateTableRowFormatOnlineResponse> - Updates the formatting properties of a table row.
-
uploadFile(
UploadFileRequest request) → Future< FilesUploadResult> - Upload file.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited