com.grapecity.documents.excel

Interface IBorders

public interface IBorders

Represents a collection of four IBorder objects that represent the four borders of an IRange or IStyle object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the borders
IBorder	get(BordersIndex index) Returns the IBorder object from a collection.
Color	getColor() Gets the Color of the IBorder.
int	getColorIndex() Gets the color of all four borders.
int	getCount() Returns the number of objects in the collection.
BorderLineStyle	getLineStyle() Gets the line style for the border.
ThemeColor	getThemeColor() Gets the theme color in the applied color scheme that is associated with the specified object.
double	getTintAndShade() Gets a value that lightens or darkens a color.
void	setColor(Color value) Sets the Color of the IBorder.
void	setColorIndex(int value) Sets the color of all four borders.
void	setLineStyle(BorderLineStyle value) Sets the line style for the border.
void	setThemeColor(ThemeColor value) Sets the theme color in the applied color scheme that is associated with the specified object.
void	setTintAndShade(double value) Sets a value that lightens or darkens a color.

Method Detail

getColor

Color getColor()

Gets the Color of the IBorder.

setColor

void setColor(Color value)

Sets the Color of the IBorder.

getColorIndex

int getColorIndex()

Gets the color of all four borders.

setColorIndex

void setColorIndex(int value)

Sets the color of all four borders.

getThemeColor

ThemeColor getThemeColor()

Gets the theme color in the applied color scheme that is associated with the specified object.

setThemeColor

void setThemeColor(ThemeColor value)

Sets the theme color in the applied color scheme that is associated with the specified object.

getTintAndShade

double getTintAndShade()

Gets a value that lightens or darkens a color. The valid number is from -1 (darkest) to 1 (lightest). Zero (0) is neutral.

setTintAndShade

void setTintAndShade(double value)

Sets a value that lightens or darkens a color. The valid number is from -1 (darkest) to 1 (lightest). Zero (0) is neutral.

getLineStyle

BorderLineStyle getLineStyle()

Gets the line style for the border.

setLineStyle

void setLineStyle(BorderLineStyle value)

Sets the line style for the border.

getCount

int getCount()

Returns the number of objects in the collection.

get

IBorder get(BordersIndex index)

Returns the IBorder object from a collection.

Parameters:

index - Specifies the position of an element in the collection.

clear

void clear()

Clear the borders