Click or drag to resize
XLSXDocument Class
A class that represents a XLSX document
Inheritance Hierarchy
SystemObject
  RasterEdge.Imaging.BasicBaseDocument
    RasterEdge.XDoc.ExcelXLSXDocument

Namespace: RasterEdge.XDoc.Excel
Assembly: RasterEdge.XDoc.Excel (in RasterEdge.XDoc.Excel.dll) Version: 9.8.7.60526 (9.8.7.60526)
Syntax
public sealed class XLSXDocument : BaseDocument

The XLSXDocument type exposes the following members.

Constructors
  NameDescription
Public methodXLSXDocument(Byte)
Create a new XLSXDocument: initialize the document variables by the excel file data
Public methodXLSXDocument(Stream)
Create a new XLSXDocument: initialize the document variables by the excel file stream
Public methodXLSXDocument(String)
Create a new XLSXDocument: initialize the document variables by the excel file path
Top
Methods
  NameDescription
Public methodAddEmptyPage
添加空白页
Public methodAddPage (Overrides BaseDocumentAddPage(BasePage).)
Public methodAddPages(BasePage) (Overrides BaseDocumentAddPages(BasePage).)
Public methodAddPages(Int32, BasePage)
Public methodAddPages(Int32, BasePage)
Public methodAppendDocument
append two documents
(Overrides BaseDocumentAppendDocument(BaseDocument).)
Public methodBurnAnnotation (Overrides BaseDocumentBurnAnnotation.)
Public methodClone
clone one page
(Overrides BaseDocumentClone.)
Public methodStatic memberCombineDocument(Stream, Stream)
Combine some documents to a document,now just support the sheet string combine;
Public methodStatic memberCombineDocument(Stream, String)
Combine some documents to a document,now just support the sheet string combine;
Public methodStatic memberCombineDocument(String, Stream)
Combine some documents to a document,now just support the sheet string combine;
Public methodStatic memberCombineDocument(String, String)
Combine some documents to a document,now just support the sheet string combine;
Public methodStatic memberCombineDocument(Stream, Stream, Int32, Int32)
//非顺序合并,just use for two documents
Public methodConvertToDocument(DocumentType, Stream)
convert the file to target type document and saved in the stream.
(Overrides BaseDocumentConvertToDocument(DocumentType, Stream).)
Public methodConvertToDocument(DocumentType, String)
convert the file to the target type document and saved in the fixed file path
(Overrides BaseDocumentConvertToDocument(DocumentType, String).)
Public methodConvertToDocument(DocumentType, ImageCompress, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, ImageCompress, Stream).)
Public methodConvertToDocument(DocumentType, ImageCompress, String)
Converts document to the target file format and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added.
(Overrides BaseDocumentConvertToDocument(DocumentType, ImageCompress, String).)
Public methodConvertToDocument(DocumentType, Int32, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, Stream).)
Public methodConvertToDocument(DocumentType, Int32, String) (Overrides BaseDocumentConvertToDocument(DocumentType, Int32, String).)
Public methodConvertToDocument(DocumentType, Stream, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, Stream, ImageOutputOption).)
Public methodConvertToDocument(DocumentType, Single, Stream) (Overrides BaseDocumentConvertToDocument(DocumentType, Single, Stream).)
Public methodConvertToDocument(DocumentType, Single, String)
Converts document to the target file format with with sepcified zoom value and saves it to a file on the local disk. Throw an exception in condition: 1: the target document type has not been developed yet. 2: the required assembly has not been added. 3: the zoom value is out of 10% ~ 2000%.
(Overrides BaseDocumentConvertToDocument(DocumentType, Single, String).)
Public methodConvertToDocument(DocumentType, String, ImageOutputOption) (Overrides BaseDocumentConvertToDocument(DocumentType, String, ImageOutputOption).)
Public methodConvertToImages(ImageType, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Stream).)
Public methodConvertToImages(ImageType, ImageOutputOption, Stream) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, Stream).)
Public methodConvertToImages(ImageType, Int32, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Int32, Stream).)
Public methodConvertToImages(ImageType, Single, Stream) (Overrides BaseDocumentConvertToImages(ImageType, Single, Stream).)
Public methodConvertToImages(ImageType, String, String) (Overrides BaseDocumentConvertToImages(ImageType, String, String).)
Public methodConvertToImages(Single, Single, ImageType, Stream)
Public methodConvertToImages(ImageType, ImageOutputOption, String, String) (Overrides BaseDocumentConvertToImages(ImageType, ImageOutputOption, String, String).)
Public methodConvertToImages(ImageType, Int32, String, String) (Overrides BaseDocumentConvertToImages(ImageType, Int32, String, String).)
Public methodConvertToImages(ImageType, Single, String, String) (Overrides BaseDocumentConvertToImages(ImageType, Single, String, String).)
Public methodConvertToImages(Single, Single, ImageType, Single, Stream)
Public methodConvertToImages(Single, Single, ImageType, String, String)
Public methodConvertToImages(Single, Single, Boolean, ImageType, Stream)
Public methodConvertToImages(Single, Single, ImageType, Single, String, String)
Public methodConvertToImages(Single, Single, Boolean, ImageType, Int32, Stream)
Public methodConvertToImages(Single, Single, Boolean, ImageType, String, String)
Public methodConvertToImages(Single, Single, Boolean, ImageType, Int32, String, String)
Public methodStatic memberConvertToODTDocument
Public methodConvertToVectorImages(ContextType, String, String, RelativeType)
Converts document to the target type file format with sepcified file name and saves it to a file on the local disk. Throw an exception in condition: 1: the target context type has not been developed yet. 2: the required assembly has not been added.
(Overrides BaseDocumentConvertToVectorImages(ContextType, String, String, RelativeType).)
Public methodConvertToVectorImages(ContextType, String, String, RelativeType, RELength, RELength) (Overrides BaseDocumentConvertToVectorImages(ContextType, String, String, RelativeType, RELength, RELength).)
Public methodStatic memberCreate
create a new xlsx document with workbook and a worksheet.
Public methodDeletePage (Overrides BaseDocumentDeletePage(Int32).)
Public methodDeletePages (Overrides BaseDocumentDeletePages(Int32, Int32).)
Public methodDispose
dispose the document
(Overrides BaseDocumentDispose.)
Public methodDuplicatePage
copy one page according to the page index
(Overrides BaseDocumentDuplicatePage(Int32).)
Public methodExtractPages(Int32, Stream)
extract the give page indexes from the document and save to the out stream;
(Overrides BaseDocumentExtractPages(Int32, Stream).)
Public methodExtractPages(Int32, String)
extract the give page indexes from the document and save to the out file;
(Overrides BaseDocumentExtractPages(Int32, String).)
Public methodGetCharsRectangle (Overrides BaseDocumentGetCharsRectangle(Int32).)
Public methodGetDocumentType (Overrides BaseDocumentGetDocumentType.)
Public methodGetFontGlyphWidths (Overrides BaseDocumentGetFontGlyphWidths(String).)
Public methodGetHyperlink (Overrides BaseDocumentGetHyperlink.)
Public methodGetNewPage (Overrides BaseDocumentGetNewPage.)
Public methodGetOutline (Overrides BaseDocumentGetOutline.)
Public methodGetPage
get one docx page by page index.
(Overrides BaseDocumentGetPage(Int32).)
Public methodGetPageCount
get the sheet count of excel.
(Overrides BaseDocumentGetPageCount.)
Public methodStatic memberGetPreviewImage(Byte, Size)
Public methodStatic memberGetPreviewImage(Stream, Size)
Public methodStatic memberGetPreviewImage(String, Size)
Public methodGetSheetCount
get visible sheet count;
Public methodGetSheetCount(Boolean)
get sheet count. if include hidden, return all sheet count,or return only visible sheet count;
Public methodGetWorkBook
get workbook to operate the XLSX document
Public methodInsertPage (Overrides BaseDocumentInsertPage(BasePage, Int32).)
Public methodInsertPages (Overrides BaseDocumentInsertPages(BasePage, Int32).)
Public methodStatic memberIsOfficeDocument
Public methodIsPageExist
judge whether the page has existed by page index
(Overrides BaseDocumentIsPageExist(Int32).)
Public methodIsPageLoaded
judge whether the page has been loaded by page index
(Overrides BaseDocumentIsPageLoaded(Int32).)
Public methodStatic memberIsXLSXDocument
Public methodMergeDocument
merge two documents
Public methodStatic memberMergeSheetContent(Stream, Stream)
merge all xlsx documents corresponding worksheets content, and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(String, String)
merge all xlsx documents corresponding worksheets content, and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(Stream, Boolean, Stream)
merge all xlsx documents corresponding worksheets content, and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(Stream, Int32, Stream)
merge all xlsx documents of the assign worksheet content by mergeSheetIndex to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(String, Boolean, String)
merge all xlsx documents corresponding worksheets content, and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(String, Int32, String)
merge all xlsx documents of the assign worksheet content by mergeSheetIndex to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(Stream, Int32, Boolean, Stream)
merge all xlsx documents of the assign worksheet content by mergeSheetIndex, row or column to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(Stream, Int32, Boolean, Stream)
merge all xlsx documents of the assign worksheet content by corresponding mergeSheetIndex, row or column to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(String, Int32, Boolean, String)
merge all xlsx documents of the assign worksheet content by mergeSheetIndex, row or column to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberMergeSheetContent(String, Int32, Boolean, String)
merge all xlsx documents of the assign worksheet content by corresponding mergeSheetIndex, row or column to the first. and output the merged document base on the first document. if other documents sheet count bigger than the first, the first create new,and put other content to it.
Public methodStatic memberOpen(Stream)
open xlsx document by the stream
Public methodStatic memberOpen(String)
open xlsx document by the fixed file path
Public methodRenderPageToImage(Int32, BaseContext)
Public methodRenderPageToImage(Int32, BaseContext, RectangleF)
render page to Context
Public methodRenderPageToImage(Int32, BaseContext, Int32)
Public methodRenderPageToImage(Int32, BaseContext, Rectangle, Size)
Public methodRenderPageToImage(Int32, BaseContext, Int32, Boolean)
Public methodSave(Stream)
Save document to Stream.(the same as the method SaveToStream,later merge them.)
Public methodSave(String)
Save to file with fixed file path
(Overrides BaseDocumentSave(String).)
Public methodSaveToBytes
save file to byte array
(Overrides BaseDocumentSaveToBytes.)
Public methodSaveToStream
Save file to Stream
(Overrides BaseDocumentSaveToStream(Stream).)
Public methodStatic memberSetDefault
Public methodStatic memberSetDivideBlock
set divided block true, divide the block by the given width,height(in inches) and resolution
Public methodStatic memberSetEmptyPages
set empty pages show or not, true-show empty pages, false-not show empty pages.
Public methodSetOutline (Overrides BaseDocumentSetOutline(REOutline).)
Public methodSetViewGridlinesList(Boolean)
decide the excel document(all sheets) show view gridlines or not
Public methodSetViewGridlinesList(Int32, Boolean)
decide the sheets(by the sheet/page index) show gridlines or not
Public methodSetViewHeadingsList(Boolean)
decide the excel document(all sheets) show view headings(A-Z...and 1-N...) or not
Public methodSetViewHeadingsList(Int32, Boolean)
decide the sheets(by the sheet/page index) show view headings(A-Z...and 1-N...) or not
Public methodStatic memberShowGridlines(Boolean)
show gridlines or not, true-show, false-not show
Public methodStatic memberShowGridlines(Int32, Boolean)
assign some pages show gridlines or not, true-show assigned pages gridlines,false-not show page index start at 0
Public methodStatic memberShowHeadings(Boolean)
show headings or not, true-show, false-not show
Public methodStatic memberShowHeadings(Int32, Boolean)
assign some pages show headings or not, true-show assigned pages headings,false-not show page index start at 0
Public methodSortPage
sort the document pages/sheets by the give page indexes, first,trim the invalid indexs(out of document pages) second,find the give page indexes,and sort the matching page indexes in the document by order
(Overrides BaseDocumentSortPage(Int32).)
Public methodStatic memberSplitDocument(Stream, Int32, Stream)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1,so the out documents count equals 2;
Public methodStatic memberSplitDocument(Stream, Int32, String)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1,so the out documents count equals 2;
Public methodStatic memberSplitDocument(Stream, Int32, Stream)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1;
Public methodStatic memberSplitDocument(Stream, Int32, String)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1;
Public methodStatic memberSplitDocument(String, Int32, Stream)
Split document into several documents.
Public methodStatic memberSplitDocument(String, Int32, Stream)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1;
Public methodStatic memberSplitDocument(String, Int32, String)
split a document to some documents by giving the page/sheet index list; the documents count equals the split index list count add 1;
Public methodStatic memberSplitDocument(String, Int32, String, String)
Public methodStatic memberStart
Public methodSwapTwoPages (Overrides BaseDocumentSwapTwoPages(Int32, Int32).)
Public methodUpdatePage
update docx page by page index
(Overrides BaseDocumentUpdatePage(BasePage, Int32).)
Top
Events
See Also