Edit

Share via

Excel.Interfaces.HeaderFooterPictureLoadOptions interface

Package:
excel

Represents a picture in the header or footer of a worksheet.

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
brightness

Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
colorType

Specifies the type of color transformation of the picture.
contrast

Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).
cropBottom

Specifies the number of points that are cropped off the bottom of the picture.
cropLeft

Specifies the number of points that are cropped off the left side of the picture.
cropRight

Specifies the number of points that are cropped off the right side of the picture.
cropTop

Specifies the number of points that are cropped off the top of the picture.
filename

Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.
height

Specifies the height of the picture in points.
lockAspectRatio

Specifies a value that indicates whether the picture retains its original proportions when resized. true if it retains its proportions; otherwise, false.
width

Specifies the width of the picture in points.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

brightness

Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

brightness?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

colorType

Specifies the type of color transformation of the picture.

colorType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

contrast

Specifies the contrast of the picture. The value for this property must be a number from 0.0 (least contrast) to 1.0 (most contrast).

contrast?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropBottom

Specifies the number of points that are cropped off the bottom of the picture.

cropBottom?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropLeft

Specifies the number of points that are cropped off the left side of the picture.

cropLeft?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropRight

Specifies the number of points that are cropped off the right side of the picture.

cropRight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropTop

Specifies the number of points that are cropped off the top of the picture.

cropTop?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

filename

Specifies the URL (on the intranet or the web) or path (local or network) to the location where the source object is saved.

filename?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

height

Specifies the height of the picture in points.

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

lockAspectRatio

Specifies a value that indicates whether the picture retains its original proportions when resized. true if it retains its proportions; otherwise, false.

lockAspectRatio?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

width

Specifies the width of the picture in points.

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]