com.groupdocs.watermark.contents

Class SpreadsheetWorksheet

java.lang.Object

com.groupdocs.watermark.contents.ContentPart

com.groupdocs.watermark.contents.SpreadsheetWorksheet

public class SpreadsheetWorksheet
extends ContentPart

Represents an Excel document worksheet.

Method Summary

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

Methods inherited from class com.groupdocs.watermark.contents.ContentPart

addWatermark, afterWatermarkAdding, checkWatermarkingLicenseRestrictions, findImages, findImages, getParts, getSearchWatermarksInParts, getStrategyManager, getTopParent, search, search, setParts, tryGetWatermarkerSettings

Methods inherited from class java.lang.Object

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

Method Detail

addModernWordArtWatermark

public final void addModernWordArtWatermark(TextWatermark watermark,
                                            SpreadsheetShapeSettings shapeSettings)

addWatermark

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

addWatermarkAsBackground

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

addWatermarkIntoHeaderFooter

public final void addWatermarkIntoHeaderFooter(Watermark watermark)

addWordArtWatermark

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

getAsposeCellsWorksheet

public final com.aspose.cells.Worksheet getAsposeCellsWorksheet()

getAttachments

public final SpreadsheetAttachmentCollection getAttachments()

Gets the collection of all attachments of this SpreadsheetWorksheet.

Returns:

The collection of all attachments of this SpreadsheetWorksheet.

getBackgroundImage

public final SpreadsheetWatermarkableImage getBackgroundImage()

Gets the background image of this SpreadsheetWorksheet.

Returns:

The background image of this SpreadsheetWorksheet or null if the worksheet has no background image.

getCharts

public final SpreadsheetChartCollection getCharts()

Gets the collection of all charts of this SpreadsheetWorksheet.

Returns:

The collection of all charts of this SpreadsheetWorksheet.

getColumnRangeWidth

public final double getColumnRangeWidth(int startColumn,
                                        int endColumn)

getColumnWidth

public final double getColumnWidth(int column)

Gets the width of the specified column in points.

Parameters:

column - The column index.

Returns:

The width of the column in points.

getColumnWidthPx

public final int getColumnWidthPx(int column)

Gets the width of the specified column in pixels.

Parameters:

column - The column index.

Returns:

The width of the column in pixels.

getColumnX

public final double getColumnX(int columnIndex)

getContentAreaHeight

public final double getContentAreaHeight()

Gets the height of the content area in points.

Returns:

The height of the content area in points.

getContentAreaHeightPx

public final int getContentAreaHeightPx()

Gets the height of the content area in pixels.

Returns:

The height of the content area in pixels.

getContentAreaWidth

public final double getContentAreaWidth()

Gets the width of the content area in points.

Returns:

The width of the content area in points.

getContentAreaWidthPx

public final int getContentAreaWidthPx()

Gets the width of the content area in pixels.

Returns:

The width of the content area in pixels.

getHeadersFooters

public final SpreadsheetHeaderFooterCollection getHeadersFooters()

Gets the collection of worksheet headers and footers.

Returns:

The collection of headers and footers.

getPageSetup

public final SpreadsheetPageSetup getPageSetup()

Gets the printing page setup for this SpreadsheetWorksheet.

Returns:

The printing page setup for this SpreadsheetWorksheet.

getRowHeight

public final double getRowHeight(int row)

Gets the height of the specified row in points.

Parameters:

row - The row index.

Returns:

The height of the row in points.

getRowHeightPx

public final int getRowHeightPx(int row)

Gets the height of the specified row in pixels.

Parameters:

row - The row index.

Returns:

The height of the row in pixels.

getRowRangeHeight

public final double getRowRangeHeight(int startRow,
                                      int endRow)

getRowY

public final double getRowY(int rowIndex)

getShapes

public final SpreadsheetShapeCollection getShapes()

Gets the collection of all shapes of this SpreadsheetWorksheet.

Returns:

The collection of all shapes of this SpreadsheetWorksheet.

getSpreadsheetDataSizeInPoints

public Size getSpreadsheetDataSizeInPoints()

resetBackgroundImageReference

public final void resetBackgroundImageReference()

setBackgroundImage

public final void setBackgroundImage(SpreadsheetWatermarkableImage value)

Sets the background image of this SpreadsheetWorksheet.

Parameters:

value - The background image of this SpreadsheetWorksheet or null if the background image should be removed.