com.mindoo.remote.api.symphony
Interface IRemoteBorder

public interface IRemoteBorder

This class represents the border of an object.

Access

• To get borders of a spreadsheet range, use the borders method in the Range class.
• To get borders of a table, use the borders method in the TextTable class.
• To get borders of a table cell, use the borders method in the TextTableCell class.

Usage

To set border properties, must set the HasBorder property to true first.

When setting width for the inner line or outer line, or setting distance between the inner line and outer line in 1/100th mm, the value of the width or distance is converted to a internal value in twip (1 inch = 1440 twips) which is the internal unit for this property in Lotus Symphony. When getting the width or distance, the internal value in twip is converted to a value in 1/100th mm and the value in 1/100th mm is returned to the user. So the value you get from the width or distance maybe different (a little larger or smaller) from the value you set to the width or distance. The following is the macro of converting a value in twip to 1/100th mm:

((TWIP) >= 0 ? (((TWIP)*127L+36L)/72L) : (((TWIP)*127L-36L)/72L))

The following is the macro of converting a value in 1/100th mm to twip :

((MM100) >= 0 ? (((MM100)*72L+63L)/127L) : (((MM100)*72L-63L)/127L))

Method Summary

int	getColor() This property returns or sets the color of the border.
int	getInnerLineWidth() This property returns or sets the width of the inner line in 1/100th mm.
int	getInnerOuterDistance() This property returns or sets the distance between the inner line and outer line in 1/100 mm.
int	getOuterLineWidth() This property returns or sets the width of the outer line in 1/100th mm.
boolean	hasBorder() This property returns or sets whether to display the border.
void	setBorder(boolean border) This property returns or sets whether to display the border.
void	setColor(int color) This property returns or sets the color of the border.
void	setInnerLineWidth(int width) This property returns or sets the width of the inner line in 1/100th mm.
void	setInnerOuterDistance(int distance) This property returns or sets the distance between the inner line and outer line in 1/100 mm.
void	setOuterLineWidth(int width) This property returns or sets the width of the outer line in 1/100th mm.

Method Detail

getColor

int getColor()
             throws RemoteEclipseAPIException

This property returns or sets the color of the border.

The value of this property is the decimal value of a color, which you can get using the RGB method in Application.

Returns:

color

Throws:

RemoteEclipseAPIException

setColor

void setColor(int color)
              throws RemoteEclipseAPIException

This property returns or sets the color of the border.

The value of this property is the decimal value of a color, which you can get using the RGB method in Application.

Parameters:

color -

Throws:

RemoteEclipseAPIException

hasBorder

boolean hasBorder()
                  throws RemoteEclipseAPIException

This property returns or sets whether to display the border.

Returns:

border

Throws:

RemoteEclipseAPIException

setBorder

void setBorder(boolean border)
               throws RemoteEclipseAPIException

This property returns or sets whether to display the border.

Parameters:

border -

Throws:

RemoteEclipseAPIException

getInnerLineWidth

int getInnerLineWidth()
                      throws RemoteEclipseAPIException

This property returns or sets the width of the inner line in 1/100th mm.

Returns:

width

Throws:

RemoteEclipseAPIException

setInnerLineWidth

void setInnerLineWidth(int width)
                       throws RemoteEclipseAPIException

This property returns or sets the width of the inner line in 1/100th mm.

Parameters:

width -

Throws:

RemoteEclipseAPIException

getOuterLineWidth

int getOuterLineWidth()
                      throws RemoteEclipseAPIException

This property returns or sets the width of the outer line in 1/100th mm.

Returns:

width

Throws:

RemoteEclipseAPIException

setOuterLineWidth

void setOuterLineWidth(int width)
                       throws RemoteEclipseAPIException

This property returns or sets the width of the outer line in 1/100th mm.

Parameters:

width -

Throws:

RemoteEclipseAPIException

getInnerOuterDistance

int getInnerOuterDistance()
                          throws RemoteEclipseAPIException

This property returns or sets the distance between the inner line and outer line in 1/100 mm.

Returns:

distance

Throws:

RemoteEclipseAPIException

setInnerOuterDistance

void setInnerOuterDistance(int distance)
                           throws RemoteEclipseAPIException

This property returns or sets the distance between the inner line and outer line in 1/100 mm.

Parameters:

distance -

Throws:

RemoteEclipseAPIException