PowerPoint.Interfaces.CustomPropertyData interface

An interface describing the data returned by calling customProperty.toJSON().

Properties

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

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?: string;

Property Value

string

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?: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";

Property Value

PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"

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 | Date | number | string;

Property Value

boolean | Date | number | string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]