PowerPoint.Interfaces.CustomPropertyLoadOptions interface

  • 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 a custom property.

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
key

The string that uniquely identifies the custom property.
type

The type of the value used for the custom property.
value

The value of the custom property. If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an InvalidArgument error.

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

key

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 string that uniquely identifies the custom property.

key?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

type

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 type of the value used for the custom property.

type?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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.

The value of the custom property. If the value is a string, the maximum length 255 characters. Larger strings cause the operation to fail with an InvalidArgument error.

value?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]