PowerPoint.CustomProperty class

Representa una propiedad personalizada.

Extends

Propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

key

Cadena que identifica de forma única la propiedad personalizada.

type

El tipo de valor utilizado para la propiedad personalizada.

value

Valor de la propiedad personalizada. Si el valor es una cadena, la longitud máxima es de 255 caracteres. Las cadenas más grandes provocan InvalidArgument un error en la operación.

Métodos

delete()

Elimina la propiedad personalizada.

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.CustomProperty es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como PowerPoint.Interfaces.CustomPropertyData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

key

Cadena que identifica de forma única la propiedad personalizada.

readonly key: string;

Valor de propiedad

string

Comentarios

Conjunto de API: PowerPointApi 1.7

type

El tipo de valor utilizado para la propiedad personalizada.

readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";

Valor de propiedad

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

Comentarios

Conjunto de API: PowerPointApi 1.7

value

Valor de la propiedad personalizada. Si el valor es una cadena, la longitud máxima es de 255 caracteres. Las cadenas más grandes provocan InvalidArgument un error en la operación.

value: boolean | Date | number | string;

Valor de propiedad

boolean | Date | number | string

Comentarios

Conjunto de API: PowerPointApi 1.7

Detalles del método

delete()

Elimina la propiedad personalizada.

delete(): void;

Devoluciones

void

Comentarios

Conjunto de API: PowerPointApi 1.7

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions): PowerPoint.CustomProperty;

Parámetros

options
PowerPoint.Interfaces.CustomPropertyLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): PowerPoint.CustomProperty;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.CustomProperty;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.CustomProperty es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como PowerPoint.Interfaces.CustomPropertyData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): PowerPoint.Interfaces.CustomPropertyData;

Devoluciones