StyleFlag

StyleFlag class

Represents flags which indicates applied formatting properties.

class StyleFlag;

Constructors

ConstructorDescription
constructor()Constructs an object with all flags as false.

Properties

PropertyTypeDescription
allbooleanAll properties will be applied.
bordersbooleanAll borders settings will be applied.
leftBorderbooleanLeft border settings will be applied.
rightBorderbooleanRight border settings will be applied.
topBorderbooleanTop border settings will be applied.
bottomBorderbooleanBottom border settings will be applied.
diagonalDownBorderbooleanDiagonal down border settings will be applied.
diagonalUpBorderbooleanDiagonal up border settings will be applied.
fontbooleanFont settings will be applied.
fontSizebooleanFont size setting will be applied.
fontNamebooleanFont name setting will be applied.
fontColorbooleanFont color setting will be applied.
fontBoldbooleanFont bold setting will be applied.
fontItalicbooleanFont italic setting will be applied.
fontUnderlinebooleanFont underline setting will be applied.
fontStrikebooleanFont strikeout setting will be applied.
fontScriptbooleanFont script setting will be applied.
numberFormatbooleanNumber format setting will be applied.
alignmentsbooleanAlignment setting will be applied.
horizontalAlignmentbooleanHorizontal alignment setting will be applied.
verticalAlignmentbooleanVertical alignment setting will be applied.
indentbooleanIndent level setting will be applied.
rotationbooleanRotation setting will be applied.
wrapTextbooleanWrap text setting will be applied.
shrinkToFitbooleanShrink to fit setting will be applied.
textDirectionbooleanText direction setting will be applied.
cellShadingbooleanCell shading setting will be applied.
lockedbooleanLocked setting will be applied.
hideFormulabooleanHide formula setting will be applied.
quotePrefixbooleanHide formula setting will be applied.

Methods

MethodDescription
getAll()@deprecated. Please use the ‘all’ property instead. All properties will be applied.
setAll(boolean)@deprecated. Please use the ‘all’ property instead. All properties will be applied.
getBorders()@deprecated. Please use the ‘borders’ property instead. All borders settings will be applied.
setBorders(boolean)@deprecated. Please use the ‘borders’ property instead. All borders settings will be applied.
getLeftBorder()@deprecated. Please use the ’leftBorder’ property instead. Left border settings will be applied.
setLeftBorder(boolean)@deprecated. Please use the ’leftBorder’ property instead. Left border settings will be applied.
getRightBorder()@deprecated. Please use the ‘rightBorder’ property instead. Right border settings will be applied.
setRightBorder(boolean)@deprecated. Please use the ‘rightBorder’ property instead. Right border settings will be applied.
getTopBorder()@deprecated. Please use the ’topBorder’ property instead. Top border settings will be applied.
setTopBorder(boolean)@deprecated. Please use the ’topBorder’ property instead. Top border settings will be applied.
getBottomBorder()@deprecated. Please use the ‘bottomBorder’ property instead. Bottom border settings will be applied.
setBottomBorder(boolean)@deprecated. Please use the ‘bottomBorder’ property instead. Bottom border settings will be applied.
getDiagonalDownBorder()@deprecated. Please use the ‘diagonalDownBorder’ property instead. Diagonal down border settings will be applied.
setDiagonalDownBorder(boolean)@deprecated. Please use the ‘diagonalDownBorder’ property instead. Diagonal down border settings will be applied.
getDiagonalUpBorder()@deprecated. Please use the ‘diagonalUpBorder’ property instead. Diagonal up border settings will be applied.
setDiagonalUpBorder(boolean)@deprecated. Please use the ‘diagonalUpBorder’ property instead. Diagonal up border settings will be applied.
getFont()@deprecated. Please use the ‘font’ property instead. Font settings will be applied.
setFont(boolean)@deprecated. Please use the ‘font’ property instead. Font settings will be applied.
getFontSize()@deprecated. Please use the ‘fontSize’ property instead. Font size setting will be applied.
setFontSize(boolean)@deprecated. Please use the ‘fontSize’ property instead. Font size setting will be applied.
getFontName()@deprecated. Please use the ‘fontName’ property instead. Font name setting will be applied.
setFontName(boolean)@deprecated. Please use the ‘fontName’ property instead. Font name setting will be applied.
getFontColor()@deprecated. Please use the ‘fontColor’ property instead. Font color setting will be applied.
setFontColor(boolean)@deprecated. Please use the ‘fontColor’ property instead. Font color setting will be applied.
getFontBold()@deprecated. Please use the ‘fontBold’ property instead. Font bold setting will be applied.
setFontBold(boolean)@deprecated. Please use the ‘fontBold’ property instead. Font bold setting will be applied.
getFontItalic()@deprecated. Please use the ‘fontItalic’ property instead. Font italic setting will be applied.
setFontItalic(boolean)@deprecated. Please use the ‘fontItalic’ property instead. Font italic setting will be applied.
getFontUnderline()@deprecated. Please use the ‘fontUnderline’ property instead. Font underline setting will be applied.
setFontUnderline(boolean)@deprecated. Please use the ‘fontUnderline’ property instead. Font underline setting will be applied.
getFontStrike()@deprecated. Please use the ‘fontStrike’ property instead. Font strikeout setting will be applied.
setFontStrike(boolean)@deprecated. Please use the ‘fontStrike’ property instead. Font strikeout setting will be applied.
getFontScript()@deprecated. Please use the ‘fontScript’ property instead. Font script setting will be applied.
setFontScript(boolean)@deprecated. Please use the ‘fontScript’ property instead. Font script setting will be applied.
get_NumberFormat()@deprecated. Please use the ’numberFormat’ property instead. Number format setting will be applied.
setNumberFormat(boolean)@deprecated. Please use the ’numberFormat’ property instead. Number format setting will be applied.
getAlignments()@deprecated. Please use the ‘alignments’ property instead. Alignment setting will be applied.
setAlignments(boolean)@deprecated. Please use the ‘alignments’ property instead. Alignment setting will be applied.
getHorizontalAlignment()@deprecated. Please use the ‘horizontalAlignment’ property instead. Horizontal alignment setting will be applied.
setHorizontalAlignment(boolean)@deprecated. Please use the ‘horizontalAlignment’ property instead. Horizontal alignment setting will be applied.
getVerticalAlignment()@deprecated. Please use the ‘verticalAlignment’ property instead. Vertical alignment setting will be applied.
setVerticalAlignment(boolean)@deprecated. Please use the ‘verticalAlignment’ property instead. Vertical alignment setting will be applied.
getIndent()@deprecated. Please use the ‘indent’ property instead. Indent level setting will be applied.
setIndent(boolean)@deprecated. Please use the ‘indent’ property instead. Indent level setting will be applied.
getRotation()@deprecated. Please use the ‘rotation’ property instead. Rotation setting will be applied.
setRotation(boolean)@deprecated. Please use the ‘rotation’ property instead. Rotation setting will be applied.
getWrapText()@deprecated. Please use the ‘wrapText’ property instead. Wrap text setting will be applied.
setWrapText(boolean)@deprecated. Please use the ‘wrapText’ property instead. Wrap text setting will be applied.
getShrinkToFit()@deprecated. Please use the ‘shrinkToFit’ property instead. Shrink to fit setting will be applied.
setShrinkToFit(boolean)@deprecated. Please use the ‘shrinkToFit’ property instead. Shrink to fit setting will be applied.
getTextDirection()@deprecated. Please use the ’textDirection’ property instead. Text direction setting will be applied.
setTextDirection(boolean)@deprecated. Please use the ’textDirection’ property instead. Text direction setting will be applied.
getCellShading()@deprecated. Please use the ‘cellShading’ property instead. Cell shading setting will be applied.
setCellShading(boolean)@deprecated. Please use the ‘cellShading’ property instead. Cell shading setting will be applied.
getLocked()@deprecated. Please use the ’locked’ property instead. Locked setting will be applied.
setLocked(boolean)@deprecated. Please use the ’locked’ property instead. Locked setting will be applied.
getHideFormula()@deprecated. Please use the ‘hideFormula’ property instead. Hide formula setting will be applied.
setHideFormula(boolean)@deprecated. Please use the ‘hideFormula’ property instead. Hide formula setting will be applied.
getQuotePrefix()@deprecated. Please use the ‘quotePrefix’ property instead. Hide formula setting will be applied.
setQuotePrefix(boolean)@deprecated. Please use the ‘quotePrefix’ property instead. Hide formula setting will be applied.
isNull()Checks whether the implementation object is null.

constructor()

Constructs an object with all flags as false.

constructor();

all

All properties will be applied.

all : boolean;

borders

All borders settings will be applied.

borders : boolean;

leftBorder

Left border settings will be applied.

leftBorder : boolean;

rightBorder

Right border settings will be applied.

rightBorder : boolean;

topBorder

Top border settings will be applied.

topBorder : boolean;

bottomBorder

Bottom border settings will be applied.

bottomBorder : boolean;

diagonalDownBorder

Diagonal down border settings will be applied.

diagonalDownBorder : boolean;

diagonalUpBorder

Diagonal up border settings will be applied.

diagonalUpBorder : boolean;

font

Font settings will be applied.

font : boolean;

fontSize

Font size setting will be applied.

fontSize : boolean;

fontName

Font name setting will be applied.

fontName : boolean;

fontColor

Font color setting will be applied.

fontColor : boolean;

fontBold

Font bold setting will be applied.

fontBold : boolean;

fontItalic

Font italic setting will be applied.

fontItalic : boolean;

fontUnderline

Font underline setting will be applied.

fontUnderline : boolean;

fontStrike

Font strikeout setting will be applied.

fontStrike : boolean;

fontScript

Font script setting will be applied.

fontScript : boolean;

numberFormat

Number format setting will be applied.

numberFormat : boolean;

alignments

Alignment setting will be applied.

alignments : boolean;

horizontalAlignment

Horizontal alignment setting will be applied.

horizontalAlignment : boolean;

verticalAlignment

Vertical alignment setting will be applied.

verticalAlignment : boolean;

indent

Indent level setting will be applied.

indent : boolean;

rotation

Rotation setting will be applied.

rotation : boolean;

wrapText

Wrap text setting will be applied.

wrapText : boolean;

shrinkToFit

Shrink to fit setting will be applied.

shrinkToFit : boolean;

textDirection

Text direction setting will be applied.

textDirection : boolean;

cellShading

Cell shading setting will be applied.

cellShading : boolean;

locked

Locked setting will be applied.

locked : boolean;

hideFormula

Hide formula setting will be applied.

hideFormula : boolean;

quotePrefix

Hide formula setting will be applied.

quotePrefix : boolean;

getAll()

@deprecated. Please use the ‘all’ property instead. All properties will be applied.

getAll() : boolean;

setAll(boolean)

@deprecated. Please use the ‘all’ property instead. All properties will be applied.

setAll(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getBorders()

@deprecated. Please use the ‘borders’ property instead. All borders settings will be applied.

getBorders() : boolean;

setBorders(boolean)

@deprecated. Please use the ‘borders’ property instead. All borders settings will be applied.

setBorders(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getLeftBorder()

@deprecated. Please use the ’leftBorder’ property instead. Left border settings will be applied.

getLeftBorder() : boolean;

setLeftBorder(boolean)

@deprecated. Please use the ’leftBorder’ property instead. Left border settings will be applied.

setLeftBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRightBorder()

@deprecated. Please use the ‘rightBorder’ property instead. Right border settings will be applied.

getRightBorder() : boolean;

setRightBorder(boolean)

@deprecated. Please use the ‘rightBorder’ property instead. Right border settings will be applied.

setRightBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getTopBorder()

@deprecated. Please use the ’topBorder’ property instead. Top border settings will be applied.

getTopBorder() : boolean;

setTopBorder(boolean)

@deprecated. Please use the ’topBorder’ property instead. Top border settings will be applied.

setTopBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getBottomBorder()

@deprecated. Please use the ‘bottomBorder’ property instead. Bottom border settings will be applied.

getBottomBorder() : boolean;

setBottomBorder(boolean)

@deprecated. Please use the ‘bottomBorder’ property instead. Bottom border settings will be applied.

setBottomBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDiagonalDownBorder()

@deprecated. Please use the ‘diagonalDownBorder’ property instead. Diagonal down border settings will be applied.

getDiagonalDownBorder() : boolean;

setDiagonalDownBorder(boolean)

@deprecated. Please use the ‘diagonalDownBorder’ property instead. Diagonal down border settings will be applied.

setDiagonalDownBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDiagonalUpBorder()

@deprecated. Please use the ‘diagonalUpBorder’ property instead. Diagonal up border settings will be applied.

getDiagonalUpBorder() : boolean;

setDiagonalUpBorder(boolean)

@deprecated. Please use the ‘diagonalUpBorder’ property instead. Diagonal up border settings will be applied.

setDiagonalUpBorder(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFont()

@deprecated. Please use the ‘font’ property instead. Font settings will be applied.

getFont() : boolean;

setFont(boolean)

@deprecated. Please use the ‘font’ property instead. Font settings will be applied.

setFont(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontSize()

@deprecated. Please use the ‘fontSize’ property instead. Font size setting will be applied.

getFontSize() : boolean;

setFontSize(boolean)

@deprecated. Please use the ‘fontSize’ property instead. Font size setting will be applied.

setFontSize(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontName()

@deprecated. Please use the ‘fontName’ property instead. Font name setting will be applied.

getFontName() : boolean;

setFontName(boolean)

@deprecated. Please use the ‘fontName’ property instead. Font name setting will be applied.

setFontName(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontColor()

@deprecated. Please use the ‘fontColor’ property instead. Font color setting will be applied.

getFontColor() : boolean;

setFontColor(boolean)

@deprecated. Please use the ‘fontColor’ property instead. Font color setting will be applied.

setFontColor(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontBold()

@deprecated. Please use the ‘fontBold’ property instead. Font bold setting will be applied.

getFontBold() : boolean;

setFontBold(boolean)

@deprecated. Please use the ‘fontBold’ property instead. Font bold setting will be applied.

setFontBold(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontItalic()

@deprecated. Please use the ‘fontItalic’ property instead. Font italic setting will be applied.

getFontItalic() : boolean;

setFontItalic(boolean)

@deprecated. Please use the ‘fontItalic’ property instead. Font italic setting will be applied.

setFontItalic(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontUnderline()

@deprecated. Please use the ‘fontUnderline’ property instead. Font underline setting will be applied.

getFontUnderline() : boolean;

setFontUnderline(boolean)

@deprecated. Please use the ‘fontUnderline’ property instead. Font underline setting will be applied.

setFontUnderline(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontStrike()

@deprecated. Please use the ‘fontStrike’ property instead. Font strikeout setting will be applied.

getFontStrike() : boolean;

setFontStrike(boolean)

@deprecated. Please use the ‘fontStrike’ property instead. Font strikeout setting will be applied.

setFontStrike(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontScript()

@deprecated. Please use the ‘fontScript’ property instead. Font script setting will be applied.

getFontScript() : boolean;

setFontScript(boolean)

@deprecated. Please use the ‘fontScript’ property instead. Font script setting will be applied.

setFontScript(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

get_NumberFormat()

@deprecated. Please use the ’numberFormat’ property instead. Number format setting will be applied.

get_NumberFormat() : boolean;

setNumberFormat(boolean)

@deprecated. Please use the ’numberFormat’ property instead. Number format setting will be applied.

setNumberFormat(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAlignments()

@deprecated. Please use the ‘alignments’ property instead. Alignment setting will be applied.

getAlignments() : boolean;

setAlignments(boolean)

@deprecated. Please use the ‘alignments’ property instead. Alignment setting will be applied.

setAlignments(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getHorizontalAlignment()

@deprecated. Please use the ‘horizontalAlignment’ property instead. Horizontal alignment setting will be applied.

getHorizontalAlignment() : boolean;

setHorizontalAlignment(boolean)

@deprecated. Please use the ‘horizontalAlignment’ property instead. Horizontal alignment setting will be applied.

setHorizontalAlignment(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getVerticalAlignment()

@deprecated. Please use the ‘verticalAlignment’ property instead. Vertical alignment setting will be applied.

getVerticalAlignment() : boolean;

setVerticalAlignment(boolean)

@deprecated. Please use the ‘verticalAlignment’ property instead. Vertical alignment setting will be applied.

setVerticalAlignment(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getIndent()

@deprecated. Please use the ‘indent’ property instead. Indent level setting will be applied.

getIndent() : boolean;

setIndent(boolean)

@deprecated. Please use the ‘indent’ property instead. Indent level setting will be applied.

setIndent(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRotation()

@deprecated. Please use the ‘rotation’ property instead. Rotation setting will be applied.

getRotation() : boolean;

setRotation(boolean)

@deprecated. Please use the ‘rotation’ property instead. Rotation setting will be applied.

setRotation(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getWrapText()

@deprecated. Please use the ‘wrapText’ property instead. Wrap text setting will be applied.

getWrapText() : boolean;

setWrapText(boolean)

@deprecated. Please use the ‘wrapText’ property instead. Wrap text setting will be applied.

setWrapText(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getShrinkToFit()

@deprecated. Please use the ‘shrinkToFit’ property instead. Shrink to fit setting will be applied.

getShrinkToFit() : boolean;

setShrinkToFit(boolean)

@deprecated. Please use the ‘shrinkToFit’ property instead. Shrink to fit setting will be applied.

setShrinkToFit(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getTextDirection()

@deprecated. Please use the ’textDirection’ property instead. Text direction setting will be applied.

getTextDirection() : boolean;

setTextDirection(boolean)

@deprecated. Please use the ’textDirection’ property instead. Text direction setting will be applied.

setTextDirection(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getCellShading()

@deprecated. Please use the ‘cellShading’ property instead. Cell shading setting will be applied.

getCellShading() : boolean;

setCellShading(boolean)

@deprecated. Please use the ‘cellShading’ property instead. Cell shading setting will be applied.

setCellShading(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getLocked()

@deprecated. Please use the ’locked’ property instead. Locked setting will be applied.

getLocked() : boolean;

setLocked(boolean)

@deprecated. Please use the ’locked’ property instead. Locked setting will be applied.

setLocked(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getHideFormula()

@deprecated. Please use the ‘hideFormula’ property instead. Hide formula setting will be applied.

getHideFormula() : boolean;

setHideFormula(boolean)

@deprecated. Please use the ‘hideFormula’ property instead. Hide formula setting will be applied.

setHideFormula(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getQuotePrefix()

@deprecated. Please use the ‘quotePrefix’ property instead. Hide formula setting will be applied.

getQuotePrefix() : boolean;

setQuotePrefix(boolean)

@deprecated. Please use the ‘quotePrefix’ property instead. Hide formula setting will be applied.

setQuotePrefix(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;