Excel.HeaderFooterPicture class
Represents a picture in the header or footer of a worksheet.
- Extends
Remarks
Properties
| brightness | Specifies the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest). |
| color |
Specifies the type of color transformation of the picture. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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). |
| crop |
Specifies the number of points that are cropped off the bottom of the picture. |
| crop |
Specifies the number of points that are cropped off the left side of the picture. |
| crop |
Specifies the number of points that are cropped off the right side of the picture. |
| crop |
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. |
| lock |
Specifies a value that indicates whether the picture retains its original proportions when resized. |
| width | Specifies the width of the picture in points. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
Property Details
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: number;Property Value
number
Remarks
colorType
Specifies the type of color transformation of the picture.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Property Value
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
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: number;Property Value
number
Remarks
cropBottom
Specifies the number of points that are cropped off the bottom of the picture.
cropBottom: number;Property Value
number
Remarks
cropLeft
Specifies the number of points that are cropped off the left side of the picture.
cropLeft: number;Property Value
number
Remarks
cropRight
Specifies the number of points that are cropped off the right side of the picture.
cropRight: number;Property Value
number
Remarks
cropTop
Specifies the number of points that are cropped off the top of the picture.
cropTop: number;Property Value
number
Remarks
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: string;Property Value
string
Remarks
height
Specifies the height of the picture in points.
height: number;Property Value
number
Remarks
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
width
Specifies the width of the picture in points.
width: number;Property Value
number
Remarks
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterPicture;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.HeaderFooterPicture): void;Parameters
- properties
- Excel.HeaderFooterPicture
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.HeaderFooterPicture object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.HeaderFooterPictureData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.HeaderFooterPictureData;