Namespace EasyXLS.Themes

Class ExcelColorScheme

System.Object

EasyXLS.Themes.ExcelColorScheme

public class ExcelColorScheme
extends System.Object

This class stores the colors information for a theme.

Constructor Summary

Constructors

Constructor	Description
ExcelColorScheme()	Defines a color scheme that is initialized with the built-in Office colors.
ExcelColorScheme(System.String builtInThemeColors)	Defines a color scheme that is initialized with the specified built-in theme colors.

Method Summary

Modifier and Type	Method	Description
System.Drawing.Color	getAccent1Color()	Returns the Accent 1 color.
System.Drawing.Color	getAccent2Color()	Returns the Accent 2 color.
System.Drawing.Color	getAccent3Color()	Returns the Accent 3 color.
System.Drawing.Color	getAccent4Color()	Returns the Accent 4 color.
System.Drawing.Color	getAccent5Color()	Returns the Accent 5 color.
System.Drawing.Color	getAccent6Color()	Returns the Accent 6 color.
System.Drawing.Color	getFollowedHyperlinkColor()	Returns the Followed Hyperlink color.
System.Drawing.Color	getHyperlinkColor()	Returns the Hyperlink color.
System.String	getName()	Returns the name of the color scheme.
System.Drawing.Color	getTextBackgroundDark1()	Returns the Text/Background-Dark 1 color.
System.Drawing.Color	getTextBackgroundDark2()	Returns the Text/Background-Dark 2 color.
System.Drawing.Color	getTextBackgroundLight1()	Returns the Text/Background-Light 1 color.
System.Drawing.Color	getTextBackgroundLight2()	Returns the Text/Background-Light 2 color.
void	InitAs(System.String builtInThemeColors)	Initializes a color scheme with the specified built-in theme colors.
bool	IsAutomaticTextBackgroundDark1()	Returns true if the Text/Background Dark 1 color is set automatically, false otherwise.
bool	IsAutomaticTextBackgroundLight1()	Returns true if the Text/Background Light 1 color is set automatically, false otherwise.
void	setAccent1Color(System.Drawing.Color accent1)	Sets the Accent 1 color.
void	setAccent2Color(System.Drawing.Color accent2)	Sets the Accent 2 color.
void	setAccent3Color(System.Drawing.Color accent3)	Sets the Accent 3 color.
void	setAccent4Color(System.Drawing.Color accent4)	Sets the Accent 4 color.
void	setAccent5Color(System.Drawing.Color accent5)	Sets the Accent 5 color.
void	setAccent6Color(System.Drawing.Color accent6)	Sets the Accent 6 color.
void	setAutomaticTextBackgroundDark1(bool isAutomatic)	Sets the automatic color for the Text/Background-Dark 1 color.
void	setAutomaticTextBackgroundLight1(bool isAutomatic)	Sets the automatic color for the Text/Background-Light 1 color.
void	setFollowedHyperlinkColor(System.Drawing.Color followedHyperlink)	Sets the Followed Hyperlink color.
void	setHyperlinkColor(System.Drawing.Color hyperlink)	Sets the Hyperlink color.
void	setName(System.String name)	Sets the name of the color scheme.
void	setTextBackgroundDark1(System.Drawing.Color textBackgroundDark1)	Sets the Text/Background-Dark 1 color.
void	setTextBackgroundDark2(System.Drawing.Color textBackgroundDark2)	Sets the Text/Background-Dark 2 color.
void	setTextBackgroundLight1(System.Drawing.Color textBackgroundLight1)	Sets the Text/Background-Light 1 color.
void	setTextBackgroundLight2(System.Drawing.Color textBackgroundLight2)	Sets the Text/Background-Light 2 color.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExcelColorScheme

public ExcelColorScheme()

Defines a color scheme that is initialized with the built-in Office colors.

ExcelColorScheme

public ExcelColorScheme(System.String builtInThemeColors)

Defines a color scheme that is initialized with the specified built-in theme colors.

Parameters:

builtInThemeColors - the predefined theme colors. Possible values are available in Theme class.

Method Details

InitAs

public void InitAs(System.String builtInThemeColors)

Initializes a color scheme with the specified built-in theme colors.

Parameters:

builtInThemeColors - the built-in theme colors. Possible values are available in Theme class.

getName

public System.String getName()

Returns the name of the color scheme.

Returns:

the name of the color scheme

See Also:

• setName(System.String)

setName

public void setName(System.String name)

Sets the name of the color scheme.

Parameters:

name - the name of the color scheme

See Also:

• getName()

getTextBackgroundDark1

public System.Drawing.Color getTextBackgroundDark1()

Returns the Text/Background-Dark 1 color.

Returns:

the Text/Background-Dark 1 color of the scheme

See Also:

• setTextBackgroundDark1(System.Drawing.Color)
• setAutomaticTextBackgroundDark1(bool)
• IsAutomaticTextBackgroundDark1()

setTextBackgroundDark1

public void setTextBackgroundDark1(System.Drawing.Color textBackgroundDark1)

Sets the Text/Background-Dark 1 color.

Parameters:

textBackgroundDark1 - the Text/Background-Dark 1 color.

See Also:

• getTextBackgroundDark1()
• setAutomaticTextBackgroundDark1(bool)
• IsAutomaticTextBackgroundDark1()

IsAutomaticTextBackgroundDark1

public bool IsAutomaticTextBackgroundDark1()

Returns true if the Text/Background Dark 1 color is set automatically, false otherwise.

Returns:

true if the Text/Background Dark 1 color is set automatically, false otherwise.

See Also:

• setAutomaticTextBackgroundDark1(bool)
• setTextBackgroundDark1(System.Drawing.Color)
• getTextBackgroundDark1()

setAutomaticTextBackgroundDark1

public void setAutomaticTextBackgroundDark1(bool isAutomatic)

Sets the automatic color for the Text/Background-Dark 1 color.

Parameters:

isAutomatic - true if the Text/Background Dark 1 color is set automatically, false otherwise.

See Also:

• IsAutomaticTextBackgroundDark1()
• setTextBackgroundDark1(System.Drawing.Color)
• getTextBackgroundDark1()

getTextBackgroundLight1

public System.Drawing.Color getTextBackgroundLight1()

Returns the Text/Background-Light 1 color.

Returns:

the Text/Background-Light 1 color of the scheme

See Also:

• setTextBackgroundLight1(System.Drawing.Color)
• setAutomaticTextBackgroundLight1(bool)
• IsAutomaticTextBackgroundLight1()

setTextBackgroundLight1

public void setTextBackgroundLight1(System.Drawing.Color textBackgroundLight1)

Sets the Text/Background-Light 1 color.

Parameters:

textBackgroundLight1 - the Text/Background-Light 1 color.

See Also:

• getTextBackgroundLight1()
• setAutomaticTextBackgroundLight1(bool)
• IsAutomaticTextBackgroundLight1()

IsAutomaticTextBackgroundLight1

public bool IsAutomaticTextBackgroundLight1()

Returns true if the Text/Background Light 1 color is set automatically, false otherwise.

Returns:

true if the Text/Background Light 1 color is set automatically, false otherwise.

See Also:

• setAutomaticTextBackgroundLight1(bool)
• setTextBackgroundLight1(System.Drawing.Color)
• getTextBackgroundLight1()

setAutomaticTextBackgroundLight1

public void setAutomaticTextBackgroundLight1(bool isAutomatic)

Sets the automatic color for the Text/Background-Light 1 color.

Parameters:

isAutomatic - true if the Text/Background Light 1 color is set automatically, false otherwise.

See Also:

• IsAutomaticTextBackgroundLight1()
• setTextBackgroundLight1(System.Drawing.Color)
• getTextBackgroundLight1()

getTextBackgroundDark2

public System.Drawing.Color getTextBackgroundDark2()

Returns the Text/Background-Dark 2 color.

Returns:

the Text/Background-Dark 2 color of the scheme

See Also:

• setTextBackgroundDark2(System.Drawing.Color)

setTextBackgroundDark2

public void setTextBackgroundDark2(System.Drawing.Color textBackgroundDark2)

Sets the Text/Background-Dark 2 color.

Parameters:

textBackgroundDark2 - the Text/Background-Dark 2 color.

See Also:

• getTextBackgroundDark2()

getTextBackgroundLight2

public System.Drawing.Color getTextBackgroundLight2()

Returns the Text/Background-Light 2 color.

Returns:

the Text/Background-Light 2 color of the scheme

See Also:

• setTextBackgroundLight2(System.Drawing.Color)

setTextBackgroundLight2

public void setTextBackgroundLight2(System.Drawing.Color textBackgroundLight2)

Sets the Text/Background-Light 2 color.

Parameters:

textBackgroundLight2 - the Text/Background-Light 2 color.

See Also:

• getTextBackgroundLight2()

getAccent1Color

public System.Drawing.Color getAccent1Color()

Returns the Accent 1 color.

Returns:

the Accent 1 color of the scheme

See Also:

• setAccent1Color(System.Drawing.Color)

setAccent1Color

public void setAccent1Color(System.Drawing.Color accent1)

Sets the Accent 1 color.

Parameters:

accent1 - the Accent 1 color.

See Also:

• getAccent1Color()

getAccent2Color

public System.Drawing.Color getAccent2Color()

Returns the Accent 2 color.

Returns:

the Accent 2 color of the scheme

See Also:

• setAccent2Color(System.Drawing.Color)

setAccent2Color

public void setAccent2Color(System.Drawing.Color accent2)

Sets the Accent 2 color.

Parameters:

accent2 - the Accent 2 color.

See Also:

• getAccent2Color()

getAccent3Color

public System.Drawing.Color getAccent3Color()

Returns the Accent 3 color.

Returns:

the Accent 3 color of the scheme

See Also:

• setAccent3Color(System.Drawing.Color)

setAccent3Color

public void setAccent3Color(System.Drawing.Color accent3)

Sets the Accent 3 color.

Parameters:

accent3 - the Accent 3 color.

See Also:

• getAccent3Color()

getAccent4Color

public System.Drawing.Color getAccent4Color()

Returns the Accent 4 color.

Returns:

the Accent 4 color of the scheme

See Also:

• setAccent4Color(System.Drawing.Color)

setAccent4Color

public void setAccent4Color(System.Drawing.Color accent4)

Sets the Accent 4 color.

Parameters:

accent4 - the Accent 4 color.

See Also:

• getAccent4Color()

getAccent5Color

public System.Drawing.Color getAccent5Color()

Returns the Accent 5 color.

Returns:

the Accent 5 color of the scheme

See Also:

• setAccent5Color(System.Drawing.Color)

setAccent5Color

public void setAccent5Color(System.Drawing.Color accent5)

Sets the Accent 5 color.

Parameters:

accent5 - the Accent 5 color.

See Also:

• getAccent5Color()

getAccent6Color

public System.Drawing.Color getAccent6Color()

Returns the Accent 6 color.

Returns:

the Accent 6 color of the scheme

See Also:

• setAccent6Color(System.Drawing.Color)

setAccent6Color

public void setAccent6Color(System.Drawing.Color accent6)

Sets the Accent 6 color.

Parameters:

accent6 - the Accent 6 color.

See Also:

• getAccent6Color()

getHyperlinkColor

public System.Drawing.Color getHyperlinkColor()

Returns the Hyperlink color.

Returns:

the Hyperlink color of the scheme

See Also:

• setHyperlinkColor(System.Drawing.Color)

setHyperlinkColor

public void setHyperlinkColor(System.Drawing.Color hyperlink)

Sets the Hyperlink color.

Parameters:

hyperlink - the Hyperlink color.

See Also:

• getHyperlinkColor()

getFollowedHyperlinkColor

public System.Drawing.Color getFollowedHyperlinkColor()

Returns the Followed Hyperlink color.

Returns:

the Followed Hyperlink color of the scheme

See Also:

• setFollowedHyperlinkColor(System.Drawing.Color)

setFollowedHyperlinkColor

public void setFollowedHyperlinkColor(System.Drawing.Color followedHyperlink)

Sets the Followed Hyperlink color.

Parameters:

followedHyperlink - the Followed Hyperlink color.

See Also:

• getFollowedHyperlinkColor()