Namespace EasyXLS
Class ExcelRow
- System.Object
-
- EasyXLS.ExcelRow
-
public class ExcelRow extends System.Object
This class is a collection of cells. It allows to access the spreadsheet cells and to set the height of the row. Also, the row can be hidden and can have a style (font name, font size, font bold, font italic, word wrap, font underline style, font subscript, font superscript, font strikethrough, background color, foreground color, horizontal alignment, vertical alignment, number or date format, row cells locked or hidden, shrink, border type, border color).
-
-
Constructor Summary
Constructors Constructor Description ExcelRow()
Defines an instance of the row.
-
Method Summary
Modifier and Type Method Description bool
AutoResize()
Returns true if the row height will be automatically computed.ExcelRow
Clone()
Creates and returns a copy of this object.int
Count()
Returns the number of cells on a row.void
easy_addCell(ExcelCell cell)
Adds the specified cell to row.ExcelCell
easy_getCell(int index)
If a cell does not exist at the specified index, it creates a cell, and returns the cell from the specified index.ExcelCell
easy_getCellAt(int index)
Returns the cell from the specified index.void
easy_insertCellAt(ExcelCell cell, int index)
Inserts the specified cell at the specified index.void
easy_removeCellAt(int index)
Removes the cell from the specified indexvoid
easy_removeCellRange(int startIndex, int count)
Removes a range of cells from the rowvoid
easy_setCellAt(ExcelCell cell, int index)
Sets the specified cell at the specified index.System.Drawing.Color
getBackground()
Returns the background color of the row.ThemeColor
getBackgroundThemeColor()
Returns the background color of the row.System.Drawing.Color
getBottomColor_Border()
Returns the color of the bottom border.int
getBottomStyle_Border()
Returns the style of the bottom border.ThemeColor
getBottomThemeColor_Border()
Returns the color of the bottom border.System.String
getDataType()
Returns the data type of the row.System.Drawing.Color
getDiagonalColor_Border()
Returns the color of the diagonal border.int
getDiagonalDownStyle_Border()
Returns the style of the diagonal down border.ThemeColor
getDiagonalThemeColor_Border()
Returns the color of the diagonal border.int
getDiagonalUpStyle_Border()
Returns the style of the diagonal up border.System.String
getFont()
Returns the name of the row font.int
getFontSize()
Returns the size of the row font.System.Drawing.Color
getForeground()
Returns the foreground color of the row.ThemeColor
getForegroundThemeColor()
Returns the foreground color of the row.System.String
getFormat()
Returns the number/date format of the row.System.Drawing.Color
getGradientColor1()
Returns the first color of the gradient fill.System.Drawing.Color
getGradientColor2()
Returns the second color of the gradient fill.int
getGradientShadingStyle()
Returns the shading style of the gradient fill.ThemeColor
getGradientThemeColor1()
Returns the first color of the gradient fill.ThemeColor
getGradientThemeColor2()
Returns the second color of the gradient fill.int
getHeight()
Returns the height of the row.System.String
getHorizontalAlignment()
Returns the horizontal alignment of the row.int
getIndent()
Returns the indent of the row.System.Drawing.Color
getLeftColor_Border()
Returns the color of the left border.int
getLeftStyle_Border()
Returns the style of the left border.ThemeColor
getLeftThemeColor_Border()
Returns the color of the left border.int
getOutlineLevel()
Internal use onlyint
getPattern()
Returns the pattern of the row.System.Drawing.Color
getPatternColor()
Returns the pattern color of the row.ThemeColor
getPatternThemeColor()
Returns the pattern color of the row.System.Drawing.Color
getRightColor_Border()
Returns the color of the right border.int
getRightStyle_Border()
Returns the style of the right border.ThemeColor
getRightThemeColor_Border()
Returns the color of the right border.ExcelStyle
getStyle()
Returns the style of the row.int
getTextDirection()
Returns the text direction of the row.int
getTextRotation()
Returns the text rotation of the row.System.Drawing.Color
getTopColor_Border()
Returns the color of the top border.int
getTopStyle_Border()
Returns the style of the top border.ThemeColor
getTopThemeColor_Border()
Returns the color of the top border.int
getUnderlineStyle()
Returns the underline style of the row font.System.String
getVerticalAlignment()
Returns the vertical alignment of the row.int
getXF()
Internal use onlybool
IsBodyFont()
Returns true if the font is the body font, false otherwise.bool
IsBold()
Returns the bold setting of the row font.bool
IsCollapsed()
Internal use onlybool
IsHeadingsFont()
Returns true if the font is the headings font, false otherwise.bool
IsHiddenFormula()
Returns the hidden setting of the row.bool
IsHiddenRow()
Returns the hidden option of the row.bool
IsItalic()
Returns the italic setting of the row font.bool
IsJustifyDistributed()
Returns the justify distributed setting of the row.bool
IsLocked()
Returns the locked setting of the row.bool
IsShrink()
Returns the shrink setting of the row.bool
IsStrikethrough()
Returns the strikethrough setting of the row font.bool
IsSubscript()
Returns the subscript setting of the row font.bool
IsSuperscript()
Returns the superscript setting of the row font.bool
IsWrap()
Returns the wrap setting of the row.void
setAutoResize(bool isAutoResize)
Sets the automatic calculation of the row height.void
setBackground(ThemeColor themeColor)
Sets the background color of the row.void
setBackground(System.Drawing.Color color)
Sets the background color of the row.void
setBodyFont()
Sets the body font.void
setBold(bool isBold)
Sets the bold option of the row font.void
setBorderColors(ThemeColor borderTop, ThemeColor borderBottom, ThemeColor borderLeft, ThemeColor borderRight)
Sets the border colors of the style.void
setBorderColors(System.Drawing.Color borderTop, System.Drawing.Color borderBottom, System.Drawing.Color borderLeft, System.Drawing.Color borderRight)
Sets the border colors of the row.void
setBorderStyles(int borderTop, int borderBottom, int borderLeft, int borderRight)
Sets the border styles of the row.void
setBottomColor_Border(ThemeColor themeColor)
Sets the color of the bottom border.void
setBottomColor_Border(System.Drawing.Color color)
Sets the color of the bottom border.void
setBottomStyle_Border(int borderStyle)
Sets the style of the bottom border.void
setCollapsed(bool isCollapsed)
Internal use onlyvoid
setDataType(System.String dataType)
Sets the data type of the row.void
setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, ThemeColor borderColor)
Sets the diagonal borders.void
setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, System.Drawing.Color borderColor)
Sets the diagonal borders.void
setFont(System.String fontName)
Sets the name of the row font.void
setFontSize(int fontSize)
Sets the size of the row font.void
setForeground(ThemeColor themeColor)
Sets the foreground color of the row.void
setForeground(System.Drawing.Color color)
Sets the foreground color of the row.void
setFormat(System.String format)
Sets the number/date format of the row.void
setGradientFill(ThemeColor themeColor1, ThemeColor themeColor2, int shadingStyle)
Sets the gradient fill for the style.void
setGradientFill(System.Drawing.Color color1, System.Drawing.Color color2, int shadingStyle)
Sets the gradient fill for the style.void
setHeadingsFont()
Sets the headings font.void
setHeight(int height)
Sets the height of the row.void
setHiddenFormula(bool isHidden)
Sets the hidden option of the row.void
setHiddenRow(bool isHidden)
Sets the hidden option of the row.void
setHorizontalAlignment(System.String horizontalAlignment)
Sets the horizontal alignment of the row.void
setIndent(int indent)
Sets the indent of the row.void
setItalic(bool isItalic)
Sets the italic option of the row font.void
setJustifyDistributed(bool isJustifyDistributed)
Sets the justify distributed option of the row.void
setLeftColor_Border(ThemeColor themeColor)
Sets the color of the left border.void
setLeftColor_Border(System.Drawing.Color color)
Sets the color of the left border.void
setLeftStyle_Border(int borderStyle)
Sets the style of the left border.void
setLocked(bool isLocked)
Sets the locked option of the row.void
setOutlineLevel(int outlineLevel)
Internal use onlyvoid
setPattern(int pattern)
Sets the pattern of the row.void
setPatternColor(ThemeColor themeColor)
Sets the pattern color of the row.void
setPatternColor(System.Drawing.Color color)
Sets the pattern color of the row.void
setRightColor_Border(ThemeColor themeColor)
Sets the color of the right border.void
setRightColor_Border(System.Drawing.Color color)
Sets the color of the right border.void
setRightStyle_Border(int borderStyle)
Sets the style of the right border.void
setShrink(bool isShrink)
Sets the shrink option of the row.void
setStrikethrough(bool isStrikethrough)
Sets the strikethrough option of the row font.void
setStyle(ExcelStyle xlsStyle)
Sets the style of the row.void
setSubscript(bool isSubscript)
Sets the subscript option of the row font.void
setSuperscript(bool isSuperscript)
Sets the superscript option of the row font.void
setTextDirection(int textDirection)
Sets the text direction of the row.void
setTextRotation(int textRotation)
Sets the text rotation of the row.void
setTopColor_Border(ThemeColor themeColor)
Sets the color of the top border.void
setTopColor_Border(System.Drawing.Color color)
Sets the color of the top border.void
setTopStyle_Border(int borderStyle)
Sets the style of the top border.void
setUnderlineStyle(int UnderlineStyle)
Sets the underline style of the row font.void
setVerticalAlignment(System.String verticalAlignment)
Sets the vertical alignment of the row.void
setWrap(bool isWrap)
Sets the wrap option of the row.void
setXF(int xfIndex)
Internal use only
-
-
-
Method Detail
-
easy_getCellAt
public ExcelCell easy_getCellAt(int index)
Returns the cell from the specified index.- Parameters:
index
- the cell index- Returns:
- the cell at specified index
- See Also:
easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_removeCellAt(int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_addCell(EasyXLS.ExcelCell)
,easy_getCell(int)
-
easy_setCellAt
public void easy_setCellAt(ExcelCell cell, int index)
Sets the specified cell at the specified index.- Parameters:
cell
- the cellindex
- the index where the cell will be set- See Also:
easy_getCellAt(int)
,easy_removeCellAt(int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_addCell(EasyXLS.ExcelCell)
,easy_getCell(int)
-
easy_removeCellAt
public void easy_removeCellAt(int index)
Removes the cell from the specified index- Parameters:
index
- the index where the cell will be removed from- See Also:
easy_getCellAt(int)
,easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_addCell(EasyXLS.ExcelCell)
,easy_getCell(int)
,easy_removeCellRange(int, int)
-
easy_removeCellRange
public void easy_removeCellRange(int startIndex, int count)
Removes a range of cells from the row- Parameters:
startIndex
- the starting index of the cellscount
- the number of cells to be removed- See Also:
easy_getCellAt(int)
,easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_addCell(EasyXLS.ExcelCell)
,easy_getCell(int)
,easy_removeCellAt(int)
-
easy_insertCellAt
public void easy_insertCellAt(ExcelCell cell, int index)
Inserts the specified cell at the specified index.- Parameters:
cell
- the cell to be insertedindex
- the index where the cell will be inserted- See Also:
easy_getCellAt(int)
,easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_removeCellAt(int)
,easy_addCell(EasyXLS.ExcelCell)
,easy_getCell(int)
-
easy_addCell
public void easy_addCell(ExcelCell cell)
Adds the specified cell to row.- Parameters:
cell
- the cell to be added- See Also:
easy_getCellAt(int)
,easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_removeCellAt(int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_getCell(int)
-
easy_getCell
public ExcelCell easy_getCell(int index)
If a cell does not exist at the specified index, it creates a cell, and returns the cell from the specified index.- Parameters:
index
- the cell index- Returns:
- the cell at specified index
- See Also:
easy_getCellAt(int)
,easy_setCellAt(EasyXLS.ExcelCell, int)
,easy_removeCellAt(int)
,easy_insertCellAt(EasyXLS.ExcelCell, int)
,easy_addCell(EasyXLS.ExcelCell)
-
Count
public int Count()
Returns the number of cells on a row.- Returns:
- the number of cells on a row.
-
getHeight
public int getHeight()
Returns the height of the row.- Returns:
- the height of the row
- See Also:
setHeight(int)
-
setHeight
public void setHeight(int height)
Sets the height of the row.- Parameters:
height
- the height of the row- See Also:
getHeight()
-
IsHiddenRow
public bool IsHiddenRow()
Returns the hidden option of the row.- Returns:
- the hidden option of the row.
- See Also:
setHiddenRow(bool)
-
setHiddenRow
public void setHiddenRow(bool isHidden)
Sets the hidden option of the row.- Parameters:
isHidden
- the hidden option of the row- See Also:
IsHiddenRow()
-
AutoResize
public bool AutoResize()
Returns true if the row height will be automatically computed.- Returns:
- true if the row height will be automatically computed.
- See Also:
setAutoResize(bool)
-
setAutoResize
public void setAutoResize(bool isAutoResize)
Sets the automatic calculation of the row height.- Parameters:
isAutoResize
- automatic calculation of the row height.- See Also:
AutoResize()
-
getDataType
public System.String getDataType()
Returns the data type of the row. The default value is DataType.AUTOMATIC. Automatic data type can be resource and time consuming and we recommend using a defined one. Possible values are available inDataType
class.- Returns:
- the data type of the row
- See Also:
setDataType(System.String)
-
setDataType
public void setDataType(System.String dataType)
Sets the data type of the row. The default value is DataType.AUTOMATIC. Automatic data type can be resource and time consuming and we recommend using a defined one. Possible values are available inDataType
class.- Parameters:
dataType
- the data type of the row- See Also:
getDataType()
-
getStyle
public ExcelStyle getStyle()
Returns the style of the row.- Returns:
- the style of the row
- See Also:
setStyle(EasyXLS.ExcelStyle)
-
setStyle
public void setStyle(ExcelStyle xlsStyle)
Sets the style of the row.- Parameters:
xlsStyle
- the style of the row- See Also:
getStyle()
-
getXF
public int getXF()
Internal use only- Returns:
- the index of the XF style
-
setXF
public void setXF(int xfIndex)
Internal use only- Parameters:
xfIndex
- the index of the XF style
-
getFormat
public System.String getFormat()
Returns the number/date format of the row. Possible values are available inFormat
class.- Returns:
- the number/date format of the row
- See Also:
setFormat(System.String)
-
setFormat
public void setFormat(System.String format)
Sets the number/date format of the row. Possible values are available inFormat
class.- Parameters:
format
- the number/date format of the row- See Also:
getFormat()
-
getHorizontalAlignment
public System.String getHorizontalAlignment()
Returns the horizontal alignment of the row. Possible values are available inAlignment
class.- Returns:
- the horizontal alignment of the row
- See Also:
setHorizontalAlignment(System.String)
-
setHorizontalAlignment
public void setHorizontalAlignment(System.String horizontalAlignment)
Sets the horizontal alignment of the row. Possible values are available inAlignment
class.- Parameters:
horizontalAlignment
- the horizontal alignment of the row- See Also:
getHorizontalAlignment()
-
getVerticalAlignment
public System.String getVerticalAlignment()
Returns the vertical alignment of the row. Possible values are available inAlignment
class.- Returns:
- the vertical alignment of the row
- See Also:
setVerticalAlignment(System.String)
-
setVerticalAlignment
public void setVerticalAlignment(System.String verticalAlignment)
Sets the vertical alignment of the row. Possible values are available inAlignment
class.- Parameters:
verticalAlignment
- the vertical alignment of the row- See Also:
getVerticalAlignment()
-
IsJustifyDistributed
public bool IsJustifyDistributed()
Returns the justify distributed setting of the row. It can only be used for distributed alignment.- Returns:
- the justify distributed setting of the row
- See Also:
setJustifyDistributed(bool)
-
setJustifyDistributed
public void setJustifyDistributed(bool isJustifyDistributed)
Sets the justify distributed option of the row. It can only be used for distributed alignment.- Parameters:
isJustifyDistributed
- the justify distributed option of the row- See Also:
IsJustifyDistributed()
-
getIndent
public int getIndent()
Returns the indent of the row.- Returns:
- the indent of the row.
- See Also:
setIndent(int)
-
setIndent
public void setIndent(int indent)
Sets the indent of the row.- Parameters:
indent
- the indent of the row.- See Also:
getIndent()
-
getTextRotation
public int getTextRotation()
Returns the text rotation of the row.- Returns:
- the text rotation of the row
- See Also:
setTextRotation(int)
-
setTextRotation
public void setTextRotation(int textRotation)
Sets the text rotation of the row.- Parameters:
textRotation
- the text rotation of the row- See Also:
getTextRotation()
-
IsWrap
public bool IsWrap()
Returns the wrap setting of the row.- Returns:
- the wrap setting of the row
- See Also:
setWrap(bool)
-
setWrap
public void setWrap(bool isWrap)
Sets the wrap option of the row.- Parameters:
isWrap
- the wrap option of the row- See Also:
IsWrap()
-
IsShrink
public bool IsShrink()
Returns the shrink setting of the row.- Returns:
- the shrink setting of the row
- See Also:
setShrink(bool)
-
setShrink
public void setShrink(bool isShrink)
Sets the shrink option of the row.- Parameters:
isShrink
- the shrink option of the row- See Also:
IsShrink()
-
getTextDirection
public int getTextDirection()
Returns the text direction of the row.- Returns:
- the text direction of the row
- See Also:
setTextDirection(int)
-
setTextDirection
public void setTextDirection(int textDirection)
Sets the text direction of the row.- Parameters:
textDirection
- the text direction of the row- See Also:
getTextDirection()
-
getFont
public System.String getFont()
Returns the name of the row font.- Returns:
- the name of the row font
- See Also:
setFont(System.String)
-
setFont
public void setFont(System.String fontName)
Sets the name of the row font.- Parameters:
fontName
- the name of the row font- See Also:
getFont()
-
IsHeadingsFont
public bool IsHeadingsFont()
Returns true if the font is the headings font, false otherwise.- Returns:
- true if the font is the headings font, false otherwise
- See Also:
setHeadingsFont()
,setFont(System.String)
-
setHeadingsFont
public void setHeadingsFont()
Sets the headings font.- See Also:
IsHeadingsFont()
,setFont(System.String)
-
IsBodyFont
public bool IsBodyFont()
Returns true if the font is the body font, false otherwise.- Returns:
- true if the font is the body font, false otherwise
- See Also:
setBodyFont()
,setFont(System.String)
-
setBodyFont
public void setBodyFont()
Sets the body font.- See Also:
IsBodyFont()
,setFont(System.String)
-
getFontSize
public int getFontSize()
Returns the size of the row font.- Returns:
- the size of the row font
- See Also:
setFontSize(int)
-
setFontSize
public void setFontSize(int fontSize)
Sets the size of the row font.- Parameters:
fontSize
- the size of the row font- See Also:
getFontSize()
-
IsBold
public bool IsBold()
Returns the bold setting of the row font.- Returns:
- the bold setting of the row font
- See Also:
setBold(bool)
-
setBold
public void setBold(bool isBold)
Sets the bold option of the row font.- Parameters:
isBold
- the bold option of the row font- See Also:
IsBold()
-
IsItalic
public bool IsItalic()
Returns the italic setting of the row font.- Returns:
- the italic setting of the row font
- See Also:
setItalic(bool)
-
setItalic
public void setItalic(bool isItalic)
Sets the italic option of the row font.- Parameters:
isItalic
- the italic option of the row font- See Also:
IsItalic()
-
getUnderlineStyle
public int getUnderlineStyle()
Returns the underline style of the row font. Possible values are available inFontSettings
class.- Returns:
- the underline style of the row font
- See Also:
setUnderlineStyle(int)
-
setUnderlineStyle
public void setUnderlineStyle(int UnderlineStyle)
Sets the underline style of the row font. Possible values are available inFontSettings
class.- Parameters:
UnderlineStyle
- underline style of the row font- See Also:
getUnderlineStyle()
-
getForeground
public System.Drawing.Color getForeground()
Returns the foreground color of the row.- Returns:
- the foreground color of the row
- See Also:
setForeground(Color)
-
getForegroundThemeColor
public ThemeColor getForegroundThemeColor()
Returns the foreground color of the row.- Returns:
- the foreground color of the row
- See Also:
setForeground(ThemeColor)
-
setForeground
public void setForeground(System.Drawing.Color color)
Sets the foreground color of the row.- Parameters:
color
- the foreground color of the row- See Also:
getForeground()
-
setForeground
public void setForeground(ThemeColor themeColor)
Sets the foreground color of the row.- Parameters:
themeColor
- the foreground color of the row- See Also:
getForegroundThemeColor()
-
IsStrikethrough
public bool IsStrikethrough()
Returns the strikethrough setting of the row font.- Returns:
- the strikethrough setting of the row font
- See Also:
setStrikethrough(bool)
-
setStrikethrough
public void setStrikethrough(bool isStrikethrough)
Sets the strikethrough option of the row font.- Parameters:
isStrikethrough
- the strikethrough option of the row font- See Also:
IsStrikethrough()
-
IsSuperscript
public bool IsSuperscript()
Returns the superscript setting of the row font.- Returns:
- the superscript setting of the row font
- See Also:
setSuperscript(bool)
-
setSuperscript
public void setSuperscript(bool isSuperscript)
Sets the superscript option of the row font.- Parameters:
isSuperscript
- the superscript option of the row font- See Also:
IsSuperscript()
-
IsSubscript
public bool IsSubscript()
Returns the subscript setting of the row font.- Returns:
- the subscript setting of the row font
- See Also:
setSubscript(bool)
-
setSubscript
public void setSubscript(bool isSubscript)
Sets the subscript option of the row font.- Parameters:
isSubscript
- the subscript option of the row font- See Also:
IsSubscript()
-
setBorderStyles
public void setBorderStyles(int borderTop, int borderBottom, int borderLeft, int borderRight)
Sets the border styles of the row. Possible values are available inBorder
class.- Parameters:
borderTop
- the border style for the top side of the cellborderBottom
- the border style for the bottom side of the cellborderLeft
- the border style for the left side of the cellborderRight
- the border style for the right side of the cell.- See Also:
getTopStyle_Border()
,getBottomStyle_Border()
,getLeftStyle_Border()
,getRightStyle_Border()
,setBorderColors(System.Drawing.Color, System.Drawing.Color, System.Drawing.Color, System.Drawing.Color)
-
getTopStyle_Border
public int getTopStyle_Border()
Returns the style of the top border. Possible values are available inBorder
class.- Returns:
- the style of the top border
- See Also:
setTopStyle_Border(int)
-
setTopStyle_Border
public void setTopStyle_Border(int borderStyle)
Sets the style of the top border. Possible values are available inBorder
class.- Parameters:
borderStyle
- the style of the top border- See Also:
getTopStyle_Border()
-
getBottomStyle_Border
public int getBottomStyle_Border()
Returns the style of the bottom border. Possible values are available inBorder
class.- Returns:
- the style of the bottom border
- See Also:
setBottomStyle_Border(int)
-
setBottomStyle_Border
public void setBottomStyle_Border(int borderStyle)
Sets the style of the bottom border. Possible values are available inBorder
class.- Parameters:
borderStyle
- the style of the bottom border- See Also:
getBottomStyle_Border()
-
getLeftStyle_Border
public int getLeftStyle_Border()
Returns the style of the left border. Possible values are available inBorder
class.- Returns:
- the style of the left border
- See Also:
setLeftStyle_Border(int)
-
setLeftStyle_Border
public void setLeftStyle_Border(int borderStyle)
Sets the style of the left border. Possible values are available inBorder
class.- Parameters:
borderStyle
- the style of the left border- See Also:
getLeftStyle_Border()
-
getRightStyle_Border
public int getRightStyle_Border()
Returns the style of the right border. Possible values are available inBorder
class.- Returns:
- the style of the right border
- See Also:
setRightStyle_Border(int)
-
setRightStyle_Border
public void setRightStyle_Border(int borderStyle)
Sets the style of the right border. Possible values are available inBorder
class.- Parameters:
borderStyle
- the style of the right border- See Also:
getRightStyle_Border()
-
setBorderColors
public void setBorderColors(System.Drawing.Color borderTop, System.Drawing.Color borderBottom, System.Drawing.Color borderLeft, System.Drawing.Color borderRight)
Sets the border colors of the row.- Parameters:
borderTop
- the border color for the top side of the cellborderBottom
- the border color for the bottom side of the cellborderLeft
- the border color for the left side of the cellborderRight
- the border color for the right side of the cell.- See Also:
getTopColor_Border()
,getBottomColor_Border()
,getLeftColor_Border()
,getRightColor_Border()
,setBorderStyles(int, int, int, int)
-
setBorderColors
public void setBorderColors(ThemeColor borderTop, ThemeColor borderBottom, ThemeColor borderLeft, ThemeColor borderRight)
Sets the border colors of the style.- Parameters:
borderTop
- the border color in the top of cellborderBottom
- the border color in the bottom of cellborderLeft
- the border color in the left of cellborderRight
- the border color in the right of cell- See Also:
getTopThemeColor_Border()
,getBottomThemeColor_Border()
,getLeftThemeColor_Border()
,getRightThemeColor_Border()
,setBorderStyles(int, int, int, int)
-
getTopColor_Border
public System.Drawing.Color getTopColor_Border()
Returns the color of the top border.- Returns:
- the color of the top border
- See Also:
setTopColor_Border(System.Drawing.Color)
-
getTopThemeColor_Border
public ThemeColor getTopThemeColor_Border()
Returns the color of the top border.- Returns:
- the color of the top border
- See Also:
setTopColor_Border(ThemeColor)
-
setTopColor_Border
public void setTopColor_Border(System.Drawing.Color color)
Sets the color of the top border.- Parameters:
color
- the color of the top border- See Also:
getTopColor_Border()
-
setTopColor_Border
public void setTopColor_Border(ThemeColor themeColor)
Sets the color of the top border.- Parameters:
themeColor
- the color of the top border- See Also:
getTopThemeColor_Border()
-
getBottomColor_Border
public System.Drawing.Color getBottomColor_Border()
Returns the color of the bottom border.- Returns:
- the color of the bottom border
- See Also:
setBottomColor_Border(System.Drawing.Color)
-
getBottomThemeColor_Border
public ThemeColor getBottomThemeColor_Border()
Returns the color of the bottom border.- Returns:
- the color of the bottom border
- See Also:
setBottomColor_Border(ThemeColor)
-
setBottomColor_Border
public void setBottomColor_Border(System.Drawing.Color color)
Sets the color of the bottom border.- Parameters:
color
- the color of the bottom border- See Also:
getBottomColor_Border()
-
setBottomColor_Border
public void setBottomColor_Border(ThemeColor themeColor)
Sets the color of the bottom border.- Parameters:
themeColor
- the color of the bottom border- See Also:
getBottomThemeColor_Border()
-
getLeftColor_Border
public System.Drawing.Color getLeftColor_Border()
Returns the color of the left border.- Returns:
- the color of the left border
- See Also:
setLeftColor_Border(System.Drawing.Color)
-
getLeftThemeColor_Border
public ThemeColor getLeftThemeColor_Border()
Returns the color of the left border.- Returns:
- the color of the left border
- See Also:
setLeftColor_Border(ThemeColor)
-
setLeftColor_Border
public void setLeftColor_Border(System.Drawing.Color color)
Sets the color of the left border.- Parameters:
color
- the color of the left border- See Also:
getLeftColor_Border()
-
setLeftColor_Border
public void setLeftColor_Border(ThemeColor themeColor)
Sets the color of the left border.- Parameters:
themeColor
- the color of the left border- See Also:
getLeftThemeColor_Border()
-
getRightColor_Border
public System.Drawing.Color getRightColor_Border()
Returns the color of the right border.- Returns:
- the color of the right border
- See Also:
setRightColor_Border(System.Drawing.Color)
-
getRightThemeColor_Border
public ThemeColor getRightThemeColor_Border()
Returns the color of the right border.- Returns:
- the color of the right border
- See Also:
setRightColor_Border(ThemeColor)
-
setRightColor_Border
public void setRightColor_Border(System.Drawing.Color color)
Sets the color of the right border.- Parameters:
color
- the color of the right border- See Also:
getRightColor_Border()
-
setRightColor_Border
public void setRightColor_Border(ThemeColor themeColor)
Sets the color of the right border.- Parameters:
themeColor
- the color of the right border- See Also:
getRightThemeColor_Border()
-
setDiagonalBorder
public void setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, System.Drawing.Color borderColor)
Sets the diagonal borders.- Parameters:
borderDiagonalUp
- true if the diagonal up border is setborderDiagonalDown
- true if the diagonal down border is setborderStyle
- the style of the diagonal border. Possible values are available inBorder
class.borderColor
- the color of the diagonal border- See Also:
getDiagonalUpStyle_Border()
,getDiagonalDownStyle_Border()
,getDiagonalColor_Border()
,setDiagonalBorder(bool,bool,int,ThemeColor)
-
setDiagonalBorder
public void setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, ThemeColor borderColor)
Sets the diagonal borders.- Parameters:
borderDiagonalUp
- true if the diagonal up border is setborderDiagonalDown
- true if the diagonal down border is setborderStyle
- the style of the diagonal border. Possible values are available inBorder
class.borderColor
- the color of the diagonal border- See Also:
getDiagonalUpStyle_Border()
,getDiagonalDownStyle_Border()
,getDiagonalColor_Border()
,setDiagonalBorder(bool,bool,int,Color)
-
getDiagonalUpStyle_Border
public int getDiagonalUpStyle_Border()
Returns the style of the diagonal up border. Possible values are available inBorder
class.- Returns:
- the style of the diagonal up border
- See Also:
setDiagonalBorder(bool,bool,int,Color)
,setDiagonalBorder(bool,bool,int,ThemeColor)
-
getDiagonalDownStyle_Border
public int getDiagonalDownStyle_Border()
Returns the style of the diagonal down border. Possible values are available inBorder
class.- Returns:
- the style of the diagonal down border
- See Also:
setDiagonalBorder(bool,bool,int,Color)
,setDiagonalBorder(bool,bool,int,ThemeColor)
-
getDiagonalColor_Border
public System.Drawing.Color getDiagonalColor_Border()
Returns the color of the diagonal border.- Returns:
- the color of the diagonal border
- See Also:
setDiagonalBorder(bool,bool,int,Color)
-
getDiagonalThemeColor_Border
public ThemeColor getDiagonalThemeColor_Border()
Returns the color of the diagonal border.- Returns:
- the color of the diagonal border
- See Also:
setDiagonalBorder(bool,bool,int,ThemeColor)
-
getBackground
public System.Drawing.Color getBackground()
Returns the background color of the row.- Returns:
- the background color of the row
- See Also:
setBackground(System.Drawing.Color)
-
getBackgroundThemeColor
public ThemeColor getBackgroundThemeColor()
Returns the background color of the row.- Returns:
- the background color of the row
- See Also:
setBackground(ThemeColor)
-
setBackground
public void setBackground(System.Drawing.Color color)
Sets the background color of the row.- Parameters:
color
- the background color of the row- See Also:
getBackground()
-
setBackground
public void setBackground(ThemeColor themeColor)
Sets the background color of the row.- Parameters:
themeColor
- the background color of the row- See Also:
getBackgroundThemeColor()
-
getPattern
public int getPattern()
Returns the pattern of the row.- Returns:
- the pattern of the row
- See Also:
setPattern(int)
-
setPattern
public void setPattern(int pattern)
Sets the pattern of the row.- Parameters:
pattern
- the pattern of the row- See Also:
getPattern()
-
getPatternColor
public System.Drawing.Color getPatternColor()
Returns the pattern color of the row.- Returns:
- the pattern color of the row
- See Also:
setPatternColor(System.Drawing.Color)
-
getPatternThemeColor
public ThemeColor getPatternThemeColor()
Returns the pattern color of the row.- Returns:
- the pattern color of the row
- See Also:
setPatternColor(ThemeColor)
-
setPatternColor
public void setPatternColor(System.Drawing.Color color)
Sets the pattern color of the row.- Parameters:
color
- the pattern color of the row- See Also:
getPatternColor()
-
setPatternColor
public void setPatternColor(ThemeColor themeColor)
Sets the pattern color of the row.- Parameters:
themeColor
- the pattern color of the row- See Also:
getPatternThemeColor()
-
getGradientColor1
public System.Drawing.Color getGradientColor1()
Returns the first color of the gradient fill.- Returns:
- the first color of the gradient fill
- See Also:
setGradientFill(Color,Color,int)
-
getGradientColor2
public System.Drawing.Color getGradientColor2()
Returns the second color of the gradient fill.- Returns:
- the second color of the gradient fill
- See Also:
setGradientFill(Color,Color,int)
-
setGradientFill
public void setGradientFill(System.Drawing.Color color1, System.Drawing.Color color2, int shadingStyle)
Sets the gradient fill for the style.- Parameters:
color1
- the first color of the gradient fillcolor2
- the second color of the gradient fillshadingStyle
- the shading style of the gradient fill. Possible values are available inFill
class.- See Also:
setGradientFill(ThemeColor, ThemeColor, int)
,getGradientColor1()
,getGradientColor2()
,getGradientShadingStyle()
-
getGradientThemeColor1
public ThemeColor getGradientThemeColor1()
Returns the first color of the gradient fill.- Returns:
- the first color of the gradient fill
- See Also:
setGradientFill(ThemeColor,ThemeColor,int)
-
getGradientThemeColor2
public ThemeColor getGradientThemeColor2()
Returns the second color of the gradient fill.- Returns:
- the second color of the gradient fill
- See Also:
setGradientFill(ThemeColor,ThemeColor,int)
-
setGradientFill
public void setGradientFill(ThemeColor themeColor1, ThemeColor themeColor2, int shadingStyle)
Sets the gradient fill for the style.- Parameters:
themeColor1
- the first color of the gradient fillthemeColor2
- the second color of the gradient fillshadingStyle
- the shading style of the gradient fill. Possible values are available inFill
class.- See Also:
setGradientFill(Color, Color, int)
,getGradientThemeColor1()
,getGradientThemeColor2()
,getGradientShadingStyle()
-
getGradientShadingStyle
public int getGradientShadingStyle()
Returns the shading style of the gradient fill. Possible values are available inFill
class.- Returns:
- the shading style of the gradient fill
- See Also:
setGradientFill(Color, Color, int)
,setGradientFill(ThemeColor, ThemeColor, int)
-
IsLocked
public bool IsLocked()
Returns the locked setting of the row.- Returns:
- the locked setting of the row
- See Also:
setLocked(bool)
-
setLocked
public void setLocked(bool isLocked)
Sets the locked option of the row.- Parameters:
isLocked
- the locked option of the row- See Also:
IsLocked()
-
IsHiddenFormula
public bool IsHiddenFormula()
Returns the hidden setting of the row.- Returns:
- the hidden setting of the row
- See Also:
setHiddenFormula(bool)
-
setHiddenFormula
public void setHiddenFormula(bool isHidden)
Sets the hidden option of the row.- Parameters:
isHidden
- the hidden option of the row- See Also:
IsHiddenFormula()
-
getOutlineLevel
public int getOutlineLevel()
Internal use only- Returns:
- the outline level
-
setOutlineLevel
public void setOutlineLevel(int outlineLevel)
Internal use only- Parameters:
outlineLevel
- the outline level
-
IsCollapsed
public bool IsCollapsed()
Internal use only- Returns:
- true if collapsed, false otherwise
-
setCollapsed
public void setCollapsed(bool isCollapsed)
Internal use only- Parameters:
isCollapsed
- true if collapsed, false otherwise
-
Clone
public ExcelRow Clone()
Creates and returns a copy of this object.- Returns:
- a clone of this instance.
-
-