SpreadsheetWorksheet

Inheritance: java.lang.Object, com.groupdocs.watermark.contents.ContentPart

public class SpreadsheetWorksheet extends ContentPart

Represents an Excel document worksheet.

Methods

Method	Description
getSpreadsheetDataSizeInPoints()
getPageSetup()	Gets the printing page setup for this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
getContentAreaWidth()	Gets the width of the content area in points.
getContentAreaWidthPx()	Gets the width of the content area in pixels.
getContentAreaHeight()	Gets the height of the content area in points.
getContentAreaHeightPx()	Gets the height of the content area in pixels.
getShapes()	Gets the collection of all shapes of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
getAttachments()	Gets the collection of all attachments of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
getCharts()	Gets the collection of all charts of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
getBackgroundImage()	Gets the background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
setBackgroundImage(SpreadsheetWatermarkableImage value)	Sets the background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).
getHeadersFooters()	Gets the collection of worksheet headers and footers.
getAsposeCellsWorksheet()
getColumnWidth(int column)	Gets the width of the specified column in points.
getColumnWidthPx(int column)	Gets the width of the specified column in pixels.
getRowHeight(int row)	Gets the height of the specified row in points.
getRowHeightPx(int row)	Gets the height of the specified row in pixels.
addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)
addWatermarkIntoHeaderFooter(Watermark watermark)
addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)
addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)
getRowY(int rowIndex)
getColumnX(int columnIndex)
getRowRangeHeight(int startRow, int endRow)
getColumnRangeWidth(int startColumn, int endColumn)
resetBackgroundImageReference()

getSpreadsheetDataSizeInPoints()

public Size getSpreadsheetDataSizeInPoints()

Returns: Size

getPageSetup()

public final SpreadsheetPageSetup getPageSetup()

Gets the printing page setup for this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Returns: SpreadsheetPageSetup - The printing page setup for this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

getContentAreaWidth()

public final double getContentAreaWidth()

Gets the width of the content area in points.

Returns: double - The width of the content area in points.

getContentAreaWidthPx()

public final int getContentAreaWidthPx()

Gets the width of the content area in pixels.

Returns: int - The width of the content area in pixels.

getContentAreaHeight()

public final double getContentAreaHeight()

Gets the height of the content area in points.

Returns: double - The height of the content area in points.

getContentAreaHeightPx()

public final int getContentAreaHeightPx()

Gets the height of the content area in pixels.

Returns: int - The height of the content area in pixels.

getShapes()

public final SpreadsheetShapeCollection getShapes()

Gets the collection of all shapes of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Returns: SpreadsheetShapeCollection - The collection of all shapes of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

getAttachments()

public final SpreadsheetAttachmentCollection getAttachments()

Gets the collection of all attachments of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Returns: SpreadsheetAttachmentCollection - The collection of all attachments of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

getCharts()

public final SpreadsheetChartCollection getCharts()

Gets the collection of all charts of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Returns: SpreadsheetChartCollection - The collection of all charts of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

getBackgroundImage()

public final SpreadsheetWatermarkableImage getBackgroundImage()

Gets the background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Returns: SpreadsheetWatermarkableImage - The background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet) or null if the worksheet has no background image.

setBackgroundImage(SpreadsheetWatermarkableImage value)

public final void setBackgroundImage(SpreadsheetWatermarkableImage value)

Sets the background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet).

Parameters:

Parameter	Type	Description
value	SpreadsheetWatermarkableImage	The background image of this [SpreadsheetWorksheet](../../com.groupdocs.watermark.contents/spreadsheetworksheet) or null if the background image should be removed.

getHeadersFooters()

public final SpreadsheetHeaderFooterCollection getHeadersFooters()

Gets the collection of worksheet headers and footers.

Returns: SpreadsheetHeaderFooterCollection - The collection of headers and footers.

getAsposeCellsWorksheet()

public final Worksheet getAsposeCellsWorksheet()

Returns: com.aspose.cells.Worksheet

getColumnWidth(int column)

public final double getColumnWidth(int column)

Gets the width of the specified column in points.

Parameters:

Parameter	Type	Description
column	int	The column index.

Returns: double - The width of the column in points.

getColumnWidthPx(int column)

public final int getColumnWidthPx(int column)

Gets the width of the specified column in pixels.

Parameters:

Parameter	Type	Description
column	int	The column index.

Returns: int - The width of the column in pixels.

getRowHeight(int row)

public final double getRowHeight(int row)

Gets the height of the specified row in points.

Parameters:

Parameter	Type	Description
row	int	The row index.

Returns: double - The height of the row in points.

getRowHeightPx(int row)

public final int getRowHeightPx(int row)

Gets the height of the specified row in pixels.

Parameters:

Parameter	Type	Description
row	int	The row index.

Returns: int - The height of the row in pixels.

addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)

public final void addWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)

Parameters:

Parameter	Type	Description
watermark	Watermark
shapeSettings	SpreadsheetShapeSettings
effects	ISpreadsheetWatermarkEffects

addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)

public final void addWatermarkAsBackground(Watermark watermark, int backgroundWidth, int backgroundHeight)

Parameters:

Parameter	Type	Description
watermark	Watermark
backgroundWidth	int
backgroundHeight	int

addWatermarkIntoHeaderFooter(Watermark watermark)

public final void addWatermarkIntoHeaderFooter(Watermark watermark)

Parameters:

Parameter	Type	Description
watermark	Watermark

addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)

public final void addModernWordArtWatermark(TextWatermark watermark, SpreadsheetShapeSettings shapeSettings)

Parameters:

Parameter	Type	Description
watermark	TextWatermark
shapeSettings	SpreadsheetShapeSettings

addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)

public final void addWordArtWatermark(Watermark watermark, SpreadsheetShapeSettings shapeSettings, ISpreadsheetWatermarkEffects effects)

Parameters:

Parameter	Type	Description
watermark	Watermark
shapeSettings	SpreadsheetShapeSettings
effects	ISpreadsheetWatermarkEffects

getRowY(int rowIndex)

public final double getRowY(int rowIndex)

Parameters:

Parameter	Type	Description
rowIndex	int

Returns: double

getColumnX(int columnIndex)

public final double getColumnX(int columnIndex)

Parameters:

Parameter	Type	Description
columnIndex	int

Returns: double

getRowRangeHeight(int startRow, int endRow)

public final double getRowRangeHeight(int startRow, int endRow)

Parameters:

Parameter	Type	Description
startRow	int
endRow	int

Returns: double

getColumnRangeWidth(int startColumn, int endColumn)

public final double getColumnRangeWidth(int startColumn, int endColumn)

Parameters:

Parameter	Type	Description
startColumn	int
endColumn	int

Returns: double

resetBackgroundImageReference()

public final void resetBackgroundImageReference()