Edit

Excel.Interfaces.RangeFillLoadOptions interface

  • Reference
Package:
excel

Represents the background of a range object.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
color

HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")
pattern

The pattern of a range. See Excel.FillPattern for details. LinearGradient and RectangularGradient are not supported. A null value indicates that the entire range doesn't have a uniform pattern setting.
patternColor

The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").
patternTintAndShade

Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform patternTintAndShade settings.
tintAndShade

Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform tintAndShade settings.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

color

HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")

color?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

pattern

The pattern of a range. See Excel.FillPattern for details. LinearGradient and RectangularGradient are not supported. A null value indicates that the entire range doesn't have a uniform pattern setting.

pattern?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

patternColor

The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").

patternColor?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

patternTintAndShade

Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform patternTintAndShade settings.

patternTintAndShade?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

tintAndShade

Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the range doesn't have uniform tintAndShade settings.

tintAndShade?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]