PowerPoint.SlideBackgroundSolidFill class
Represents PowerPoint.SlideBackground solid fill properties.
- Extends
Remarks
Properties
| color | Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| transparency | Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). |
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 |
| toJSON() | Overrides the JavaScript |
Property Details
color
Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
color: string;Property Value
string
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
transparency
Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
transparency: 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?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;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[]): PowerPoint.SlideBackgroundSolidFill;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;
}): PowerPoint.SlideBackgroundSolidFill;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
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 PowerPoint.SlideBackgroundSolidFill object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideBackgroundSolidFillData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;