Compartir a través de

PowerPoint.CustomProperty class

  • Referencia
Paquete:
powerpoint

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa una propiedad personalizada.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
key

Cadena que identifica de forma única la propiedad personalizada.
type

Tipo del valor usado 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 hacen que se produzca un InvalidArgument 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()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.CustomProperty es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.CustomPropertyData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

key

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cadena que identifica de forma única la propiedad personalizada.

readonly key: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

type

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Tipo del valor usado 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 BETA (SOLO VERSIÓN PRELIMINAR) ]

value

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

value: boolean | Date | number | string;

Valor de propiedad

boolean | Date | number | string

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

delete()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Elimina la propiedad personalizada.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

load(options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

PowerPoint.CustomProperty

load(propertyNames)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

PowerPoint.CustomProperty

load(propertyNamesAndPaths)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

PowerPoint.CustomProperty

toJSON()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.CustomProperty es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.CustomPropertyData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): PowerPoint.Interfaces.CustomPropertyData;

Devoluciones

PowerPoint.Interfaces.CustomPropertyData