Edit

Share via

PowerPoint.Borders class

  • Reference
Package:
powerpoint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the borders for a table cell.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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.
diagonalDown

Gets the diagonal border (top-left to bottom-right).
diagonalUp

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 context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
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.

Property Details

bottom

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the bottom border.

readonly bottom: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

PowerPoint.RequestContext

diagonalDown

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the diagonal border (top-left to bottom-right).

readonly diagonalDown: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

diagonalUp

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the diagonal border (bottom-left to top-right).

readonly diagonalUp: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

left

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the left border.

readonly left: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

right

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the right border.

readonly right: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

top

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the top border.

readonly top: PowerPoint.Border;

Property Value

PowerPoint.Border

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

options
PowerPoint.Interfaces.BordersLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Borders

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

PowerPoint.Borders

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

PowerPoint.Borders

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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;

Returns

PowerPoint.Interfaces.BordersData