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

public interface IRemoteName

This class represents a named range. A named range is a range with a specified name. A range can have more than one name.

Creation and access

• To create a named range, use the add method in the Names class.
• To get a named range, use the item method in the Names class.

Method Summary

java.lang.String	getName() This property returns or sets the name of the range.
java.lang.String	getRefersTo() This property returns a string that represents the range that the named range refers to.
IRemoteRange	getRefersToRange() This property returns the range of the named range refers to.
java.lang.String	getValue() This property returns or sets a string value that represents the range that the named range refers to.
void	remove() This method removes the named range.
void	setName(java.lang.String name) This property returns or sets the name of the range.
void	setValue(java.lang.String value) This property returns or sets a string value that represents the range that the named range refers to.

Method Detail

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets the name of the range.

Returns:

name

Throws:

RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets the name of the range.

Parameters:

name -

Throws:

RemoteEclipseAPIException

getRefersTo

java.lang.String getRefersTo()
                             throws RemoteEclipseAPIException

This property returns a string that represents the range that the named range refers to. The format of this property is: $SheetName.$StartColumn$StartRow:$EndColumn$EndRow. For example, $A.$A$1:$E$11 specifies the range (A1:E11) on sheet A.

Returns:

refersTo

Throws:

RemoteEclipseAPIException

getRefersToRange

IRemoteRange getRefersToRange()
                              throws RemoteEclipseAPIException

This property returns the range of the named range refers to.

Returns:

range

Throws:

RemoteEclipseAPIException

getValue

java.lang.String getValue()
                          throws RemoteEclipseAPIException

This property returns or sets a string value that represents the range that the named range refers to. The format of this property is: $SheetName.$StartColumn$StartRow:$EndColumn$EndRow. For example, $A.$A$1:$E$11 specifies the range (A1:E11) on sheet A.

Returns:

value

Throws:

RemoteEclipseAPIException

setValue

void setValue(java.lang.String value)
              throws RemoteEclipseAPIException

This property returns or sets a string value that represents the range that the named range refers to. The format of this property is: $SheetName.$StartColumn$StartRow:$EndColumn$EndRow. For example, $A.$A$1:$E$11 specifies the range (A1:E11) on sheet A.

Parameters:

value -

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method removes the named range.

Throws:

RemoteEclipseAPIException