PowerPoint.CustomProperty class
Representa uma propriedade personalizada.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.7 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| key | A cadeia que identifica exclusivamente a propriedade personalizada. |
| type | O tipo do valor utilizado para a propriedade personalizada. |
| value | O valor da propriedade personalizada. Se o valor for uma cadeia, o comprimento máximo é de 255 carateres. Cadeias maiores fazem com que a operação falhe com um |
Métodos
| delete() | Exclui a propriedade personalizada. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
key
A cadeia que identifica exclusivamente a propriedade personalizada.
readonly key: string;Valor da propriedade
string
Comentários
type
O tipo do valor utilizado para a propriedade personalizada.
readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";Valor da propriedade
PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"
Comentários
value
O valor da propriedade personalizada. Se o valor for uma cadeia, o comprimento máximo é de 255 carateres. Cadeias maiores fazem com que a operação falhe com um InvalidArgument erro.
value: boolean | Date | number | string;Valor da propriedade
boolean | Date | number | string
Comentários
Detalhes do método
delete()
Exclui a propriedade personalizada.
delete(): void;Retornos
void
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions): PowerPoint.CustomProperty;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): PowerPoint.CustomProperty;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.CustomProperty;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.CustomProperty é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.CustomPropertyData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.CustomPropertyData;