IRemoteRange

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteRange

public interface IRemoteRange

This class represents a cell, a row, a column, or a collection of cells in the a sheet.

Access

To access all the used range of a sheet, use the UsedRange property in the Sheet class.
To access the range of a cell in the a sheet, use the Cells method in the Sheet class.
To access the range of a column in the a sheet, use the Columns method in the Sheet class.
To access the range of a row in the a sheet, use the Rows method in the Sheet class.
To access the range of a cell by name, use the Range method in the Sheet class.
To access the entire row (or rows) that contain the specified range, use the EntireRow property in the Range class.
To access the entire column (or columns) that contain the specified range, use the EntireColumn property in the Range class.
To access the range of a cell in the a range, use the Cells method in the Range class.
To access the range of a column in the a range, use the Columns method in the Range class.
To access the range of a row in the a range, use the Rows method in the Range class.
To offset a range, use the Offset method in the Range class.
To access the range of a cell by name, use the Range method in the Range class.
To resize a range, use the Resize method in the Range class.

Usage

Range provides access to cells, columns, and rows, and methods to provide sort, group, and subtotal operations.

To change the style of the range, use the Borders method and the BackColor and Font properties.

To set formulas in cell, use the Formula property.
The value of a cell can be a string value or a double value. The property Text is used to set the string value of a cell. The property Value is used to set the double value of a cell. The value for the Text property and Value property can overwrite each other's value in the following manner:

When you set the value for the Text property, the value of the Value property is the numeric conversion value of the Text property's value.
When you set the value for the Value property, the value of the Text property is the string conversion value of the Value property's value.

For example, if you set the Text property's value to Test, the Value property's value is 0; if you set the Value property's value to 26.7, the Text property's value is 26.7.

Method Summary
`void`	`autoFit()` This method sets a reasonable size for each cell of the range automatically.
`void`	`autoFormat(java.lang.String tableStyleName)` This method applies a table style for the range.
`IRemoteBorder`	`borders(int position)` This method returns a Border object that represents a border of the range.
`IRemoteRange`	`cells()` This method returns a Range object that represents a cell or all the cells in the specified range.
`IRemoteRange`	`cells(int rowIndex)` This method returns a Range object that represents a cell or all the cells in the specified range.
`IRemoteRange`	`cells(int rowIndex, int columnIndex)` This method returns a Range object that represents a cell or all the cells in the specified range.
`void`	`clear()` This method clears format information, including BackColor, and all Font properties.
`IRemoteRange`	`columns()` This method returns a Range object that represents one column or all the columns in the specified range.
`IRemoteRange`	`columns(int index)` This method returns a Range object that represents one column or all the columns in the specified range.
`void`	`copy()` This method copies the selected range to the clipboard.
`void`	`cut()` This method cuts the selected range to the clipboard.
`IRemoteSymphonyApplication`	`getApplication()` This property represents the Lotus Symphony application.
`int`	`getBackColor()` This property represents the background color of the range.
`java.lang.String`	`getCellStyleName()` This property returns or sets the cell style of a range.
`int`	`getColumn()` This property returns the number of columns in this range.
`int`	`getColumnWidth()` This property returns or sets the column width in 1/100th mm.
`int`	`getCount()` When the current range is specified from columns, the Count property returns the number of columns in the current range.
`int`	`getCurrentSheetIndex()` This property returns the index of the current sheet of a range.
`int`	`getEndColumn()` This property returns the absolute index of the last column of the range.
`int`	`getEndRow()` This property returns the absolute index of the last row of the range.
`IRemoteRange`	`getEntireColumn()` This property returns a Range object that represents the entire column or columns that contains the specified range.
`IRemoteRange`	`getEntireRow()` This property returns a Range object that represents the entire row or rows that contains the specified range.
`IRemoteFont`	`getFont()` This property returns a Font object that represents the font of the range.
`java.lang.String`	`getFormula()` This property returns or sets the formula for this range.
`int`	`getHeight()` This property returns the height of the range in 1/100th mm.
`int`	`getHoriAlignment()` This property returns the horizontal alignment from the first cell in a range or sets the horizontal alignment of all cells in a range.
`java.lang.String`	`getName()` This property returns the name of the range.
`IRemoteNumberFormat`	`getNumberFormat()` This property returns a NumberFormat object that represents the number format of the range.
`int`	`getRow()` This property returns the number of rows of the range.
`int`	`getRowHeight()` This property returns or sets row width in 1/100th mm.
`IRemoteSheet`	`getSheet()` This property returns the sheet containing current range.
`int`	`getStartColumn()` This property returns the absolute index of the first column of the range.
`int`	`getStartRow()` This property returns the absolute index of the first row of the range.
`java.lang.String`	`getText()` This property returns the text from the first cell in this range or sets the text to all cells in this range.
`double`	`getValue()` This property returns the value from the first cell in this range or sets the value to all cells in this range.
`int`	`getVertAlignment()` This property returns the vertical alignment from the first cell in a range or sets the vertical alignment of all cells in a range.
`int`	`getWidth()` This property returns the width of this range in 1/100th mm.
`int`	`getWrapText()` This property returns or sets whether the text wraps in the range.
`void`	`group(int orientation)` This method creates an outline group for the range.
`int`	`hasFormula()` This property returns whether this range has a formula.
`void`	`insertHyperLink(java.lang.String displayName, java.lang.String url)` This method inserts a hyperlink in the current range.
`boolean`	`isFormulaHidden()` True means that the formula of the range is hidden from the user.
`boolean`	`isHidden()` True means that the range is hidden from the user.
`boolean`	`isMergeCell()` Set this property to true to merge all cells of the range to one cell.
`boolean`	`isPrintHidden()` True means that the range is hidden on printouts.
`boolean`	`isProtected()` This property specifies if the range can be modified when the sheet is not modifiable from the user interface.
`IRemoteRange`	`offset(int rowOffset, int columnOffset)` This method returns a Range object that represents a range that is offset from the specified range.
`void`	`paste()` This method pastes the content from the clipboard into the current range.
`IRemoteRange`	`range(IRemoteRange range1, IRemoteRange range2)` This method returns a Range object that represents a cell or a range of cells.
`IRemoteRange`	`range(java.lang.String name)` This method returns a Range object that represents a cell or a range of cells.
`int`	`replace(java.lang.String what, java.lang.String replacement, boolean matchcase)` This method replaces all specified text in a range with other text.
`IRemoteRange`	`resize(int rowSize, int colSize)` This method resizes the specified range and returns a Range object that represents the resized range.
`IRemoteRange`	`rows()` This method returns a Range object that represents one row or all the rows in the specified range.
`IRemoteRange`	`rows(int index)` This method returns a Range object that represents one row or all the rows in the specified range.
`void`	`select()` This method selects the current range.
`void`	`setBackColor(int color)` This property represents the background color of the range.
`void`	`setCellStyleName(java.lang.String styleName)` This property returns or sets the cell style of a range.
`void`	`setColumnWidth(int width)` This property returns or sets the column width in 1/100th mm.
`void`	`setFormula(java.lang.String formula)` This property returns or sets the formula for this range.
`void`	`setFormulaHidden(boolean hidden)` True means that the formula of the range is hidden from the user.
`void`	`setHidden(boolean hidden)` True means that the range is hidden from the user.
`void`	`setHoriAlignment(int hori)` This property returns the horizontal alignment from the first cell in a range or sets the horizontal alignment of all cells in a range.
`void`	`setMergeCell(boolean merge)` Set this property to true to merge all cells of the range to one cell.
`void`	`setPrintHidden(boolean hidden)` True means that the range is hidden on printouts.
`void`	`setProtected(boolean protect)` This property specifies if the range can be modified when the sheet is not modifiable from the user interface.
`void`	`setRowHeight(int rowHeight)` This property returns or sets row width in 1/100th mm.
`void`	`setText(java.lang.String text)` This property returns the text from the first cell in this range or sets the text to all cells in this range.
`void`	`setValue(double value)` This property returns the value from the first cell in this range or sets the value to all cells in this range.
`void`	`setVertAlignment(int vert)` This property returns the vertical alignment from the first cell in a range or sets the vertical alignment of all cells in a range.
`void`	`setWrapText(int wrap)` This property returns or sets whether the text wraps in the range.
`void`	`sort(int key1, int order1, int key2, int order2, int key3, int order3, int type, boolean matchCase, int orientation, boolean header)` This method sorts a range of values.
`void`	`subtotal(java.lang.String[] columnList, int groupby, int function, boolean replace, boolean pagebreak, boolean enablesort, boolean sortAscending)` This method creates subtotals for the range.
`void`	`unGroup(int orientation)` This method removes the group.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:: application
Throws:: RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

When the current range is specified from columns, the Count property returns the number of columns in the current range. When the current range is specified from rows, the Count property returns the number of rows in the current range. When the current range is specified from a range of cells, the Count property returns the number of cells in the current range.

Returns:: count
Throws:: RemoteEclipseAPIException

getColumn

int getColumn()
              throws RemoteEclipseAPIException

This property returns the number of columns in this range. The maximum number of columns in a sheet is 1024.

Returns:: column
Throws:: RemoteEclipseAPIException

getColumnWidth

int getColumnWidth()
                   throws RemoteEclipseAPIException

This property returns or sets the column width in 1/100th mm. If the return value is 65537, the width of the columns are different from each other.

Returns:: width
Throws:: RemoteEclipseAPIException

setColumnWidth

void setColumnWidth(int width)
                    throws RemoteEclipseAPIException

This property returns or sets the column width in 1/100th mm. If the return value is 65537, the width of the columns are different from each other.

Parameters:: width -
Throws:: RemoteEclipseAPIException

getEntireRow

IRemoteRange getEntireRow()
                          throws RemoteEclipseAPIException

This property returns a Range object that represents the entire row or rows that contains the specified range.

Returns:: row range
Throws:: RemoteEclipseAPIException

getEntireColumn

IRemoteRange getEntireColumn()
                             throws RemoteEclipseAPIException

This property returns a Range object that represents the entire column or columns that contains the specified range.

Returns:: column range
Throws:: RemoteEclipseAPIException

getStartRow

int getStartRow()
                throws RemoteEclipseAPIException

This property returns the absolute index of the first row of the range.

Returns:: index
Throws:: RemoteEclipseAPIException

getStartColumn

int getStartColumn()
                   throws RemoteEclipseAPIException

This property returns the absolute index of the first column of the range.

Returns:: index
Throws:: RemoteEclipseAPIException

getEndRow

int getEndRow()
              throws RemoteEclipseAPIException

This property returns the absolute index of the last row of the range.

Returns:: index
Throws:: RemoteEclipseAPIException

getEndColumn

int getEndColumn()
                 throws RemoteEclipseAPIException

This property returns the absolute index of the last column of the range.

Returns:: index
Throws:: RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns the name of the range.

Returns:: name
Throws:: RemoteEclipseAPIException

getFont

IRemoteFont getFont()
                    throws RemoteEclipseAPIException

This property returns a Font object that represents the font of the range.

Returns:: font
Throws:: RemoteEclipseAPIException

getFormula

java.lang.String getFormula()
                            throws RemoteEclipseAPIException

This property returns or sets the formula for this range. The value is the formula that is supported by Lotus Symphony, such as: "=A4+B4".

Returns:: formula
Throws:: RemoteEclipseAPIException

setFormula

void setFormula(java.lang.String formula)
                throws RemoteEclipseAPIException

This property returns or sets the formula for this range. The value is the formula that is supported by Lotus Symphony, such as: "=A4+B4".

Parameters:: formula -
Throws:: RemoteEclipseAPIException

hasFormula

int hasFormula()
               throws RemoteEclipseAPIException

This property returns whether this range has a formula.

Legal values:

Constant	Description
Constant.SYMPHONY_BOOL_YES	specifies that all cells in this range contain a formula
Constant.SYMPHONY_BOOL_NO	specifies that none cells contain a formula
Constant.SYMPHONY_BOOL_MISCELLANEOUS	specifies that some cells contain a formula and others do not

Returns:: value
Throws:: RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

This property returns the height of the range in 1/100th mm.

Returns:: height
Throws:: RemoteEclipseAPIException

isMergeCell

boolean isMergeCell()
                    throws RemoteEclipseAPIException

Set this property to true to merge all cells of the range to one cell. If all the cells of current range have been merged, the property returns true, otherwise returns false.

Returns:: merge
Throws:: RemoteEclipseAPIException

setMergeCell

void setMergeCell(boolean merge)
                  throws RemoteEclipseAPIException

Set this property to true to merge all cells of the range to one cell. If all the cells of current range have been merged, the property returns true, otherwise returns false.

Parameters:: merge -
Throws:: RemoteEclipseAPIException

setProtected

void setProtected(boolean protect)
                  throws RemoteEclipseAPIException

This property specifies if the range can be modified when the sheet is not modifiable from the user interface. After calling the Protect method of the Sheet class, no matter set Protected property of a range to true or false, the range can not be modified.

Parameters:: protect -
Throws:: RemoteEclipseAPIException

isFormulaHidden

boolean isFormulaHidden()
                        throws RemoteEclipseAPIException

True means that the formula of the range is hidden from the user. This property only takes effect after calling the Protect method of Sheet, when the current sheet is not modifiable.

Returns:: hidden
Throws:: RemoteEclipseAPIException

setFormulaHidden

void setFormulaHidden(boolean hidden)
                      throws RemoteEclipseAPIException

True means that the formula of the range is hidden from the user. This property only takes effect after calling the Protect method of Sheet, when the current sheet is not modifiable.

Parameters:: hidden -
Throws:: RemoteEclipseAPIException

isHidden

boolean isHidden()
                 throws RemoteEclipseAPIException

True means that the range is hidden from the user. This property only takes effect after calling the Protect method of the Sheet class, when the current sheet is not modifiable from UI.

Returns:: hidden
Throws:: RemoteEclipseAPIException

setHidden

void setHidden(boolean hidden)
               throws RemoteEclipseAPIException

True means that the range is hidden from the user. This property only takes effect after calling the Protect method of the Sheet class, when the current sheet is not modifiable from UI.

Parameters:: hidden -
Throws:: RemoteEclipseAPIException

isPrintHidden

boolean isPrintHidden()
                      throws RemoteEclipseAPIException

True means that the range is hidden on printouts.

Returns:: hidden
Throws:: RemoteEclipseAPIException

setPrintHidden

void setPrintHidden(boolean hidden)
                    throws RemoteEclipseAPIException

True means that the range is hidden on printouts.

Parameters:: hidden -
Throws:: RemoteEclipseAPIException

getRow

int getRow()
           throws RemoteEclipseAPIException

This property returns the number of rows of the range. The maximum number of rows in a sheet is 65536.

Returns:: row
Throws:: RemoteEclipseAPIException

getRowHeight

int getRowHeight()
                 throws RemoteEclipseAPIException

This property returns or sets row width in 1/100th mm. If the value returned is 65537, then the height of rows are different from each other.

Returns:: rowHeight
Throws:: RemoteEclipseAPIException

setRowHeight

void setRowHeight(int rowHeight)
                  throws RemoteEclipseAPIException

This property returns or sets row width in 1/100th mm. If the value returned is 65537, then the height of rows are different from each other.

Parameters:: rowHeight -
Throws:: RemoteEclipseAPIException

getText

java.lang.String getText()
                         throws RemoteEclipseAPIException

This property returns the text from the first cell in this range or sets the text to all cells in this range.

Returns:: text
Throws:: RemoteEclipseAPIException

setText

void setText(java.lang.String text)
             throws RemoteEclipseAPIException

This property returns the text from the first cell in this range or sets the text to all cells in this range.

Parameters:: text -
Throws:: RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException

This property returns the value from the first cell in this range or sets the value to all cells in this range.

Returns:: value
Throws:: RemoteEclipseAPIException

setValue

void setValue(double value)
              throws RemoteEclipseAPIException

This property returns the value from the first cell in this range or sets the value to all cells in this range.

Parameters:: value -
Throws:: RemoteEclipseAPIException

getWidth

int getWidth()
             throws RemoteEclipseAPIException

This property returns the width of this range in 1/100th mm.

Returns:: width
Throws:: RemoteEclipseAPIException

getSheet

IRemoteSheet getSheet()
                      throws RemoteEclipseAPIException

This property returns the sheet containing current range.

Returns:: sheet
Throws:: RemoteEclipseAPIException

getWrapText

int getWrapText()
                throws RemoteEclipseAPIException

This property returns or sets whether the text wraps in the range.

Legal values:

Constant	Description
Constant.SYMPHONY_BOOL_YES	specifies that text of all cells in this range wraps
Constant.SYMPHONY_BOOL_NO	specifies that none cells contain text that wraps
Constant.SYMPHONY_BOOL_MISCELLANEOUS	specifies that some of the cells contain text that wraps and others do not

Returns:: wrap
Throws:: RemoteEclipseAPIException

setWrapText

void setWrapText(int wrap)
                 throws RemoteEclipseAPIException

This property returns or sets whether the text wraps in the range.

Legal values:

Constant	Description
Constant.SYMPHONY_BOOL_YES	specifies that text of all cells in this range wraps
Constant.SYMPHONY_BOOL_NO	specifies that none cells contain text that wraps
Constant.SYMPHONY_BOOL_MISCELLANEOUS	specifies that some of the cells contain text that wraps and others do not

Parameters:: wrap -
Throws:: RemoteEclipseAPIException

clear

void clear()
           throws RemoteEclipseAPIException

This method clears format information, including BackColor, and all Font properties.

Throws:: RemoteEclipseAPIException

group

void group(int orientation)
           throws RemoteEclipseAPIException

This method creates an outline group for the range.

Parameters:

orientation - Specifies the range group by column or row. The value can be a GroupSort orientation constant.

When the value is Constant.SYMPHONY_ORIENTATION_COLUMN, it creates a group by column.
When the value is Constant.SYMPHONY_ORIENTATION_ROW, it creates a group by row.

Throws:

RemoteEclipseAPIException

sort

void sort(int key1,
          int order1,
          int key2,
          int order2,
          int key3,
          int order3,
          int type,
          boolean matchCase,
          int orientation,
          boolean header)
          throws RemoteEclipseAPIException

This method sorts a range of values.

Parameters:: key1 - Specifies the first sort field and can be any index of the column or row in the range, determined by the parameter orientation, starting at 1. If the column or row index is out of bounds, this method throws an exception.; order1 - Specifies the sort order for the values specified in parameter key1. The value can be a sort order constant.; key2 - Specifies the second sort field and can be any index of the column or row in the range, and determined by the parameter orientation. If the column or row index is out of bounds, this method throws an exception.; order2 - Specifies the sort order for the values specified in parameter key2. The value is the same as the parameter order1.; key3 - Specifies the third sort field and can be any index of the column or row in the range, and determined by the parameter orientation. If the column or row index is out of bounds, this method throws an exception.; order3 - Specifies the sort order for the values specified in parameter key3. The value is the same as the parameter order1.; type - Specifies the sort type and can be a sort type constant.; matchCase - Specifies whether match case. A value of true matches the case.; orientation - Specifies whether to sort by column or row and can be a GroupSort orientation constant. A value of Constant.SYMPHONY_ORIENTATION_COLUMN sorts by column. A value of Constant.SYMPHONY_ORIENTATION_ROW sorts by row.; header - true means that the first column or row is the header, false means the first column or row is not the header.
Throws:: RemoteEclipseAPIException

subtotal

void subtotal(java.lang.String[] columnList,
              int groupby,
              int function,
              boolean replace,
              boolean pagebreak,
              boolean enablesort,
              boolean sortAscending)
              throws RemoteEclipseAPIException

This method creates subtotals for the range.

Parameters:: columnList - Specifies which columns are subtotal columns and can be any index of the column in the range. If the column index is out of bounds, this method throws an exception.; groupby - Specifies which column of the source range is used to group the contents of the source data and can be any index of column of this range, starting at 1. If the column index is out of bounds, this method throws an exception.; function - Specifies what kind of subtotals are calculated, and the value can be a general function constant.; replace - Specifies whether to replace previous data. A value of true replaces the previous data.; pagebreak - Specifies whether to insert page break after each group. A value of false does not insert and a value of true does insert.; enablesort - Specifies whether to sort the field. A value of true enable the sort operation.; sortAscending - Specifies whether to sort in an ascending sequence. A value of true sorts in an ascending sequence. A value of false sorts in an descending sequence.
Throws:: RemoteEclipseAPIException

unGroup

void unGroup(int orientation)
             throws RemoteEclipseAPIException

This method removes the group.

Parameters:

orientation -

A value of Constant.SYMPHONY_ORIENTATION_COLUMN groups by column.
A value of Constant.SYMPHONY_ORIENTATION_ROW groups by row.

Throws:

RemoteEclipseAPIException

borders

IRemoteBorder borders(int position)
                      throws RemoteEclipseAPIException

This method returns a Border object that represents a border of the range.

Parameters:: position - Specifies the position of the border and can be a border type constant.
Returns:: A Border object that represents a border.
Throws:: RemoteEclipseAPIException

cells

IRemoteRange cells(int rowIndex,
                   int columnIndex)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or all the cells in the specified range.

Parameters:

rowIndex - Specifies the row index in the range, starting at 1.If the row index is out of bounds, this method throws an exception.

columnIndex - Specifies the column index in the range, starting at 1.If the column index is out of bounds, this method throws an exception.

Returns:

range:

cells() returns a Range object that represents the whole range.
cells( int rowIndex) returns a Range object that represents a row of the range.
cells(int rowIndex, int columnIndex) returns a Range object that represents a cell.

Throws:

RemoteEclipseAPIException

cells

IRemoteRange cells()
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or all the cells in the specified range.

Returns:

range:

cells() returns a Range object that represents the whole range.
cells( int rowIndex) returns a Range object that represents a row of the range.
cells(int rowIndex, int columnIndex) returns a Range object that represents a cell.

Throws:

RemoteEclipseAPIException

cells

IRemoteRange cells(int rowIndex)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or all the cells in the specified range.

Parameters:

rowIndex - Specifies the row index in the range, starting at 1.If the row index is out of bounds, this method throws an exception.

Returns:

range:

cells() returns a Range object that represents the whole range.
cells( int rowIndex) returns a Range object that represents a row of the range.
cells(int rowIndex, int columnIndex) returns a Range object that represents a cell.

Throws:

RemoteEclipseAPIException

columns

IRemoteRange columns()
                     throws RemoteEclipseAPIException

This method returns a Range object that represents one column or all the columns in the specified range.

Returns:

range:

columns() returns a Range object that represents the whole range.
columns( int rowIndex) returns a Range object that represents a column of the range.

Throws:

RemoteEclipseAPIException

columns

IRemoteRange columns(int index)
                     throws RemoteEclipseAPIException

This method returns a Range object that represents one column or all the columns in the specified range.

Parameters:

index - Specifies the column index in the range, starting at 1. If the column index is out of bounds, this method throws an exception.

Returns:

range:

columns() returns a Range object that represents the whole range.
columns( int rowIndex) returns a Range object that represents a column of the range.

Throws:

RemoteEclipseAPIException

offset

IRemoteRange offset(int rowOffset,
                    int columnOffset)
                    throws RemoteEclipseAPIException

This method returns a Range object that represents a range that is offset from the specified range.

Parameters:: rowOffset - Specifies the offset of row.; columnOffset - Specifies offset of column.
Returns:: A Range object.
Throws:: RemoteEclipseAPIException

resize

IRemoteRange resize(int rowSize,
                    int colSize)
                    throws RemoteEclipseAPIException

This method resizes the specified range and returns a Range object that represents the resized range.

Parameters:: rowSize - Specifies the new number of rows.; colSize - Specifies the new number of columns.
Returns:: A Range object that represents the resized range.
Throws:: RemoteEclipseAPIException

rows

IRemoteRange rows()
                  throws RemoteEclipseAPIException

This method returns a Range object that represents one row or all the rows in the specified range.

Returns:

range

rows() returns a Range object that represents the whole range.
rows( int rowIndex) returns a Range object that represents a row of the range.

Throws:

RemoteEclipseAPIException

rows

IRemoteRange rows(int index)
                  throws RemoteEclipseAPIException

This method returns a Range object that represents one row or all the rows in the specified range.

Parameters:

index - Specifies the row index in the sheet, starting at 1. If the row index is out of bounds, this method throws an exception.

Returns:

range

rows() returns a Range object that represents the whole range.
rows( int rowIndex) returns a Range object that represents a row of the range.

Throws:

RemoteEclipseAPIException

range

IRemoteRange range(IRemoteRange range1,
                   IRemoteRange range2)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or a range of cells.
range( range1, range2 ) returns the union range of range1 and range2.

Parameters:: range1 - Specifies the start of the new range.; range2 - Specifies the end of the new range.
Returns:: A Range object that represents a cell or a range of cells.
Throws:: RemoteEclipseAPIException

range

IRemoteRange range(java.lang.String name)
                   throws RemoteEclipseAPIException

This method returns a Range object that represents a cell or a range of cells.

Parameters:: name - Specifies the range name of the new range. The name of range can represent a single cell, such as "A1", or represent a range containing a collection of cells, such as : "C2:E20", "B1:D10".
Returns:: A Range object that represents a cell or a range of cells.
Throws:: RemoteEclipseAPIException

autoFit

void autoFit()
             throws RemoteEclipseAPIException

This method sets a reasonable size for each cell of the range automatically.

Throws:: RemoteEclipseAPIException

autoFormat

void autoFormat(java.lang.String tableStyleName)
                throws RemoteEclipseAPIException

This method applies a table style for the range.

Parameters:: tableStyleName - Specifies the name of a table style.
Throws:: RemoteEclipseAPIException

cut

void cut()
         throws RemoteEclipseAPIException

This method cuts the selected range to the clipboard.

Throws:: RemoteEclipseAPIException

copy

void copy()
          throws RemoteEclipseAPIException

This method copies the selected range to the clipboard.

Throws:: RemoteEclipseAPIException

paste

void paste()
           throws RemoteEclipseAPIException

This method pastes the content from the clipboard into the current range. When the range in the clipboard is larger than the range to paste, or the range to paste has data already, calling paste method causes the application to freeze.

Throws:: RemoteEclipseAPIException

replace

int replace(java.lang.String what,
            java.lang.String replacement,
            boolean matchcase)
            throws RemoteEclipseAPIException

This method replaces all specified text in a range with other text.

Parameters:: what - Specifies the text in the range to be replaced.; replacement - Specifies the text that replaces the text specified by the what parameter.; matchcase - Specifies whether to match case. A value of true matches case, and a value of false does not match case.
Returns:
Throws:: RemoteEclipseAPIException

select

void select()
            throws RemoteEclipseAPIException

This method selects the current range.

Throws:: RemoteEclipseAPIException

insertHyperLink

void insertHyperLink(java.lang.String displayName,
                     java.lang.String url)
                     throws RemoteEclipseAPIException

This method inserts a hyperlink in the current range.

Parameters:: displayName - Specifies the name of this link to display.; url - Specifies the URL of this link. You can link to a internet address or a sheet in the current spreadsheet. For example, if you want to insert a link for a sheet named "A", then the value for this parameter is "#A".
Throws:: RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property represents the background color of the range.

Defined in

The value for this property is the decimal value of a color. You can get the decimal value using the RGB method in the Application class.

Returns:: color
Throws:: RemoteEclipseAPIException

setBackColor

void setBackColor(int color)
                  throws RemoteEclipseAPIException

Parameters:: color -
Throws:: RemoteEclipseAPIException

getNumberFormat

IRemoteNumberFormat getNumberFormat()
                                    throws RemoteEclipseAPIException

This property returns a NumberFormat object that represents the number format of the range.

Returns:: format
Throws:: RemoteEclipseAPIException

getHoriAlignment

int getHoriAlignment()
                     throws RemoteEclipseAPIException

This property returns the horizontal alignment from the first cell in a range or sets the horizontal alignment of all cells in a range.
Legal values

Constant.TEXTALIGNMENT_HORIZONTAL_DEFAULT
Constant.TEXTALIGNMENT_HORIZONTAL_LEFT
Constant.TEXTALIGNMENT_HORIZONTAL_CENTER
Constant.TEXTALIGNMENT_HORIZONTAL_RIGHT
Constant.TEXTALIGNMENT_HORIZONTAL_JUSTIFIED
Constant.TEXTALIGNMENT_HORIZONTAL_FILLED

Returns:: hori
Throws:: RemoteEclipseAPIException

setHoriAlignment

void setHoriAlignment(int hori)
                      throws RemoteEclipseAPIException

This property returns the horizontal alignment from the first cell in a range or sets the horizontal alignment of all cells in a range.
Legal values

Constant.TEXTALIGNMENT_HORIZONTAL_DEFAULT
Constant.TEXTALIGNMENT_HORIZONTAL_LEFT
Constant.TEXTALIGNMENT_HORIZONTAL_CENTER
Constant.TEXTALIGNMENT_HORIZONTAL_RIGHT
Constant.TEXTALIGNMENT_HORIZONTAL_JUSTIFIED
Constant.TEXTALIGNMENT_HORIZONTAL_FILLED

Parameters:: hori -
Throws:: RemoteEclipseAPIException

getVertAlignment

int getVertAlignment()
                     throws RemoteEclipseAPIException

This property returns the vertical alignment from the first cell in a range or sets the vertical alignment of all cells in a range.

Legal values:

Constant.TEXTALIGNMENT_VERTICAL_DEFAULT
Constant.TEXTALIGNMENT_VERTICAL_TOP
Constant.TEXTALIGNMENT_VERTICAL_MIDDLE
Constant.TEXTALIGNMENT_VERTICAL_BOTTOM

Returns:: vert
Throws:: RemoteEclipseAPIException

setVertAlignment

void setVertAlignment(int vert)
                      throws RemoteEclipseAPIException

This property returns the vertical alignment from the first cell in a range or sets the vertical alignment of all cells in a range.

Legal values:

Constant.TEXTALIGNMENT_VERTICAL_DEFAULT
Constant.TEXTALIGNMENT_VERTICAL_TOP
Constant.TEXTALIGNMENT_VERTICAL_MIDDLE
Constant.TEXTALIGNMENT_VERTICAL_BOTTOM

Parameters:: vert -
Throws:: RemoteEclipseAPIException

isProtected

boolean isProtected()
                    throws RemoteEclipseAPIException

Returns:: protect
Throws:: RemoteEclipseAPIException

setCellStyleName

void setCellStyleName(java.lang.String styleName)
                      throws RemoteEclipseAPIException

This property returns or sets the cell style of a range. The cell style can only be the styles in the cell style family.

When setting cell style of a range, if the style name is not contained in the cell style family, this property throws an exception.

Parameters:: styleName -
Throws:: RemoteEclipseAPIException

getCellStyleName

java.lang.String getCellStyleName()
                                  throws RemoteEclipseAPIException

Returns:: styleName
Throws:: RemoteEclipseAPIException

getCurrentSheetIndex

int getCurrentSheetIndex()
                         throws RemoteEclipseAPIException

This property returns the index of the current sheet of a range.

Returns:: index
Throws:: RemoteEclipseAPIException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.mindoo.remote.api.symphony.spreadsheet Interface IRemoteRange

getApplication

getCount

getColumn

getColumnWidth

setColumnWidth

getEntireRow

getEntireColumn

getStartRow

getStartColumn

getEndRow

getEndColumn

getName

getFont

getFormula

setFormula

hasFormula

getHeight

isMergeCell

setMergeCell

setProtected

isFormulaHidden

setFormulaHidden

isHidden

setHidden

isPrintHidden

setPrintHidden

getRow

getRowHeight

setRowHeight

getText

setText

getValue

setValue

getWidth

getSheet

getWrapText

setWrapText

clear

group

sort

subtotal

unGroup

borders

cells

cells

cells

columns

columns

offset

resize

rows

rows

range

range

autoFit

autoFormat

cut

copy

paste

replace

select

insertHyperLink

getBackColor

setBackColor

getNumberFormat

getHoriAlignment

setHoriAlignment

getVertAlignment

setVertAlignment

isProtected

setCellStyleName

getCellStyleName

getCurrentSheetIndex

com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteRange