Excel.CustomXmlPartCollection class
Uma coleção de partes XML personalizadas.
- 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. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(xml) | Adiciona uma nova parte XML personalizada à pasta de trabalho. |
| get |
Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado. |
| get |
Obtém o número de partes XML personalizadas na coleção. |
| get |
Obtém uma parte XML personalizada com base em sua ID. |
| get |
Obtém uma parte XML personalizada com base em sua ID. Se o |
| 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.CustomXmlPart[];Valor da propriedade
Detalhes do método
add(xml)
Adiciona uma nova parte XML personalizada à pasta de trabalho.
add(xml: string): Excel.CustomXmlPart;Parâmetros
- xml
-
string
conteúdo XML. Deve ser um fragmento XML válido.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.5]
getByNamespace(namespaceUri)
Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado.
getByNamespace(namespaceUri: string): Excel.CustomXmlPartScopedCollection;Parâmetros
- namespaceUri
-
string
Deve ser um URI de esquema totalmente qualificado; Por exemplo, "http://schemas.contoso.com/review/1.0".
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.5]
getCount()
Obtém o número de partes XML personalizadas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: ExcelApi 1.5]
getItem(id)
Obtém uma parte XML personalizada com base em sua ID.
getItem(id: string): Excel.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a ser recuperado.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.5]
getItemOrNullObject(id)
Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getItemOrNullObject(id: string): Excel.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a ser recuperado.
Retornos
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.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection;Parâmetros
- options
-
Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.CustomXmlPartCollection;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?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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 Excel.CustomXmlPartCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomXmlPartCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.CustomXmlPartCollectionData;