PowerPoint.Borders class
Represents the borders for a table cell.
- Extends
Remarks
Properties
bottom | Gets the bottom border. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
diagonal |
Gets the diagonal border (top-left to bottom-right). |
diagonal |
Gets the diagonal border (bottom-left to top-right). |
left | Gets the left border. |
right | Gets the right border. |
top | Gets the top border. |
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
bottom
Gets the bottom border.
readonly bottom: PowerPoint.Border;
Property Value
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
diagonalDown
Gets the diagonal border (top-left to bottom-right).
readonly diagonalDown: PowerPoint.Border;
Property Value
Remarks
diagonalUp
Gets the diagonal border (bottom-left to top-right).
readonly diagonalUp: PowerPoint.Border;
Property Value
Remarks
left
Gets the left border.
readonly left: PowerPoint.Border;
Property Value
Remarks
right
Gets the right border.
readonly right: PowerPoint.Border;
Property Value
Remarks
top
Gets the top border.
readonly top: PowerPoint.Border;
Property Value
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.BordersLoadOptions): PowerPoint.Borders;
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.Borders;
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.Borders;
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.Borders
object is an API object, the toJSON
method returns a plain JavaScript object (typed as PowerPoint.Interfaces.BordersData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.BordersData;