Edit

Share via

PowerPoint.Adjustments class

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 adjustment values for a shape.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

context

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

Specifies the number of adjustment points.

Methods

get(index)

Gets the adjustment value at the specified zero-based index. Throws an InvalidArgument exception when the index is out of range.
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.
set(index, value)

Sets the adjustment value at the specified zero-based index. Throws an InvalidArgument exception when the index is out of range.
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.Adjustments object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.AdjustmentsData) that contains shallow copies of any loaded child properties from the original object.

Property Details

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

count

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 number of adjustment points.

readonly count: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

get(index)

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 adjustment value at the specified zero-based index. Throws an InvalidArgument exception when the index is out of range.

get(index: number): OfficeExtension.ClientResult<number>;

Parameters

index

number

The index of the adjustment to retrieve.

Returns

OfficeExtension.ClientResult<number>

The adjustment value at the given index.

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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.AdjustmentsLoadOptions): PowerPoint.Adjustments;

Parameters

options
PowerPoint.Interfaces.AdjustmentsLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Adjustments

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.Adjustments

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

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

set(index, value)

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.

Sets the adjustment value at the specified zero-based index. Throws an InvalidArgument exception when the index is out of range.

set(index: number, value: number): void;

Parameters

index

number

The index of the adjustment to set.

value

number

The adjustment value to set.

Returns

void

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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

toJSON(): PowerPoint.Interfaces.AdjustmentsData;

Returns

PowerPoint.Interfaces.AdjustmentsData