com.intechcore.scomponents.scell.api.spreadsheet.model

Interface IWorksheet

public interface IWorksheet

Represents the worksheet model

Method Summary

Modifier and Type	Method and Description
void	clear(IRangeAddress range) Removes all content (values, comments, hyperlinks, styles) from the given range
IBorderService	getBorderService()
ICommentService	getCommentService()
IFontService	getFontService()
String	getFormat(IRangeAddress range) Gets the common RAW string format code of the given range of cells
IHyperlinkService	getHyperlinkService()
int	getId()
IDrawingService	getImageService()
IWorksheetStructure	getLayout()
String	getName()
IScellApiResolver	getResolver()
IWorksheetStorage	getStorages()
IStyleService	getStyleService()
IValueService	getValueService()
void	hide(boolean hide) Hides/shows the worksheet
void	inputContent(IRangeAddress range, IRichString input) Deprecated. use IValueService.set(IRangeAddress, IValue)
void	inputContent(IRangeAddress range, String input) Deprecated. use IValueService.parseContent(IRangeAddress, String)
boolean	isHidden()
void	rename(String name) Renames the worksheet
void	setContent(IRangeAddress range, boolean cellContent) Deprecated. use IValueService.set(IRangeAddress, IValue)
void	setContent(IRangeAddress range, Number cellContent) Deprecated. use IValueService.set(IRangeAddress, IValue)
void	setFormat(IRangeAddress range, String format) Sets the RAW string format code to the cells of the given range
Stream<IEntry<IRangeAddress,String>>	streamExistingFormattedValues(IRangeAddress range) Deprecated. current method will be completely removed in future releases, but for the time being it's the only way to get formatted values

Method Detail

getId

int getId()

Returns:

the ID of the worksheet

getName

String getName()

Returns:

the name of the worksheet

isHidden

boolean isHidden()

Returns:

true if the worksheet is hidden

getLayout

IWorksheetStructure getLayout()

Returns:

IWorksheetStructure that manages rows, columns or merged cells

inputContent

@Deprecated
void inputContent(IRangeAddress range,
                              String input)

Deprecated. use IValueService.parseContent(IRangeAddress, String)

Sets single cell or range value as if it was input from UI

The input will be recognized and set as a corresponding type of content

Parameters:

range - a range or single cell address

input - a string for content recognition

See Also:

IRangeAddress

inputContent

@Deprecated
void inputContent(IRangeAddress range,
                              IRichString input)

Deprecated. use IValueService.set(IRangeAddress, IValue)

Sets single cell or range value as if it was input from UI

The input will be recognized and set as a corresponding type of content

Parameters:

range - a range or single cell address

input - a string for content recognition

See Also:

IRangeAddress, IRichString

setContent

@Deprecated
void setContent(IRangeAddress range,
                            Number cellContent)

Deprecated. use IValueService.set(IRangeAddress, IValue)

Sets numeric value into a single cell or a range of cells

Parameters:

range - a range or single cell address

cellContent - a number to be set

See Also:

IRangeAddress

setContent

@Deprecated
void setContent(IRangeAddress range,
                            boolean cellContent)

Deprecated. use IValueService.set(IRangeAddress, IValue)

Sets boolean value into to a single cell or a range of cells

Parameters:

range - a range or single cell address

cellContent - a boolean value to be set

See Also:

IRangeAddress

setFormat

void setFormat(IRangeAddress range,
               String format)

Sets the RAW string format code to the cells of the given range

see https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68

Parameters:

range - the target range

format - the format code

getFormat

String getFormat(IRangeAddress range)

Gets the common RAW string format code of the given range of cells

see https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68

Parameters:

range - the required range

Returns:

the format code

streamExistingFormattedValues

@Deprecated
Stream<IEntry<IRangeAddress,String>> streamExistingFormattedValues(IRangeAddress range)

Deprecated. current method will be completely removed in future releases, but for the time being it's the only way to get formatted values

Streams non-empty values with applied format that intersect the given range.

It means, that all numeric values will be transformed to formatted once.

For example, if cell contains integer value = 123 with IValue.ValueType.NUMERIC value type and format for this cell is set to $0.00, then this method will return $123.00 instead of 123

Parameters:

range - the range at the intersection of which values with applied formatting should be streamed.

Returns:

stream of values with applied formatting which intersecting the provided range.

rename

void rename(String name)

Renames the worksheet

Parameters:

name - the new name of the worksheet

hide

void hide(boolean hide)

Hides/shows the worksheet

Parameters:

hide - if true the worksheet will be hidden

clear

void clear(IRangeAddress range)

Removes all content (values, comments, hyperlinks, styles) from the given range

Parameters:

range - the IRangeAddress in which the content will be removed

getBorderService

IBorderService getBorderService()

Returns:

IBorderService to manage border sides and styles

getCommentService

ICommentService getCommentService()

Returns:

ICommentService to manage the comments

getImageService

IDrawingService getImageService()

Returns:

IDrawingService to manage the drawings

getFontService

IFontService getFontService()

Returns:

IFontService to manage the fonts of the cell contents

getHyperlinkService

IHyperlinkService getHyperlinkService()

Returns:

IHyperlinkService to manage the hyperlinks

getStyleService

IStyleService getStyleService()

Returns:

IStyleService to manage the styles

getValueService

IValueService getValueService()

Returns:

IValueService to manage the values the cells

getStorages

IWorksheetStorage getStorages()

Returns:

IWorksheetStorage to get the existing worksheet data

getResolver

IScellApiResolver getResolver()

Returns:

IScellApiResolver for convenience