PowerPoint.CustomProperty class
Representa uma propriedade personalizada.
- Extends
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| key | A cadeia de caracteres que identifica exclusivamente a propriedade personalizada. |
| type | O tipo do valor usado para a propriedade personalizada. |
| value | O valor da propriedade personalizada. Se o valor for uma cadeia de caracteres, o comprimento máximo será de 255 caracteres. Cadeias de caracteres 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
key
A cadeia de caracteres que identifica exclusivamente a propriedade personalizada.
readonly key: string;Valor da propriedade
string
Comentários
type
O tipo do valor usado 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 de caracteres, o comprimento máximo será de 255 caracteres. Cadeias de caracteres 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 quais propriedades do objeto devem ser carregadas.
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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original PowerPoint.CustomProperty é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.CustomPropertyData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.CustomPropertyData;