Excel.CustomXmlPart class
Representa um objeto de peça XML personalizado em uma pasta de trabalho.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.5]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| id | A ID da parte XML personalizada. |
| namespace |
O URI de namespace da parte XML personalizada. |
Métodos
| delete() | Exclui a parte XML personalizada. |
| get |
Obtém o conteúdo XML completo da parte XML 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 |
| set |
Define o conteúdo XML completo da parte XML personalizada. |
| 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
id
A ID da parte XML personalizada.
readonly id: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.5]
namespaceUri
O URI de namespace da parte XML personalizada.
readonly namespaceUri: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.5]
Detalhes do método
delete()
Exclui a parte XML personalizada.
delete(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.5]
getXml()
Obtém o conteúdo XML completo da parte XML personalizada.
getXml(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
Comentários
[Conjunto de apis: ExcelApi 1.5]
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?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart;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[]): Excel.CustomXmlPart;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;
}): Excel.CustomXmlPart;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
setXml(xml)
Define o conteúdo XML completo da parte XML personalizada.
setXml(xml: string): void;Parâmetros
- xml
-
string
conteúdo XML da peça.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.5]
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 Excel.CustomXmlPart é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomXmlPartData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.CustomXmlPartData;