Edit

Share via

PowerPoint.Border 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 properties for a table cell border.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

color

Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
dashStyle

Represents the dash style of the line.
transparency

Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
weight

Represents the weight of the line, in points.

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.Border object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.BorderData) that contains shallow copies of any loaded child properties from the original object.

Property Details

color

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 line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").

color: string | undefined;

Property Value

string | undefined

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

dashStyle

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 dash style of the line.

dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;

Property Value

PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

transparency

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.

Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).

transparency: number | undefined;

Property Value

number | undefined

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

weight

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 weight of the line, in points.

weight: number | undefined;

Property Value

number | undefined

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.BorderLoadOptions): PowerPoint.Border;

Parameters

options
PowerPoint.Interfaces.BorderLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Border

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.Border;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.Border

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.Border;

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

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.Border object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.BorderData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.BorderData;

Returns

PowerPoint.Interfaces.BorderData