com.groupdocs.editor.metadata

Class SpreadsheetDocumentInfo

java.lang.Object

com.groupdocs.editor.metadata.SpreadsheetDocumentInfo

All Implemented Interfaces:

IDocumentInfo

public class SpreadsheetDocumentInfo
extends Object
implements IDocumentInfo

Represents metadata of one Spreadsheet document

Constructor Summary

Constructors

Constructor and Description
SpreadsheetDocumentInfo()

Method Summary

Modifier and Type	Method and Description
boolean	equals(SpreadsheetDocumentInfo other) Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance
SvgImage	generatePreview(int worksheetIndex) Generates and returns a preview of the selected worksheet in a form of SVG image
SpreadsheetFormats	getFormat() Returns a format of this Spreadsheet document
int	getPageCount() Returns number of tabs
long	getSize() Returns size in bytes of this Spreadsheet document
boolean	isEncrypted() Indicates whether this specific Spreadsheet document in encrypted and requires password for opening

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpreadsheetDocumentInfo

public SpreadsheetDocumentInfo()

Method Detail

equals

public final boolean equals(SpreadsheetDocumentInfo other)

Determines whether this instance is equal to the other specified SpreadsheetDocumentInfo instance

Parameters:

other - Other SpreadsheetDocumentInfo instance, that should be checked on equality with this

Returns:

True if are equal, false if are unequal

generatePreview

public final SvgImage generatePreview(int worksheetIndex)
                               throws Exception

Generates and returns a preview of the selected worksheet in a form of SVG image

Parameters:

worksheetIndex - 0-based index of the desired worksheet. Cannot be lesser then 0, cannot exceed the number of worksheets in this spreadsheet.

Returns:

SVG image as the non-null instance of the SvgImage class

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - Specified worksheetIndex is lesser then 0 or bigger then the number of worksheets in this spreadsheet

Exception

getFormat

public final SpreadsheetFormats getFormat()

Returns a format of this Spreadsheet document

Specified by:

getFormat in interface IDocumentInfo

Returns:

getPageCount

public final int getPageCount()

Returns number of tabs

Specified by:

getPageCount in interface IDocumentInfo

Returns:

getSize

public final long getSize()

Returns size in bytes of this Spreadsheet document

Specified by:

getSize in interface IDocumentInfo

Returns:

isEncrypted

public final boolean isEncrypted()

Indicates whether this specific Spreadsheet document in encrypted and requires password for opening

Specified by:

isEncrypted in interface IDocumentInfo

Returns: