PowerPoint.BulletFormat class

Package:

powerpoint

Represents the bullet formatting properties of a text that is attached to the PowerPoint.ParagraphFormat.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.4 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
visible	Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.

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

Property Details

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

PowerPoint.RequestContext

visible

Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.

visible: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

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.BulletFormatLoadOptions): PowerPoint.BulletFormat;

Parameters

options

PowerPoint.Interfaces.BulletFormatLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.BulletFormat

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.BulletFormat

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

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

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

toJSON(): PowerPoint.Interfaces.BulletFormatData;

Returns

PowerPoint.Interfaces.BulletFormatData