Excel.CustomXmlPartScopedCollection class
Uma coleção com escopo de partes XML personalizadas. Uma coleção com escopo é o resultado de alguma operação (por exemplo, filtragem por namespace). Não é possível ter mais escopo de uma coleção com escopo.
- 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
| get |
Obtém o número de partes CustomXML nesta 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 |
| get |
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método produzirá um erro. |
| get |
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método retornará |
| 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
getCount()
Obtém o número de partes CustomXML nesta 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]
getOnlyItem()
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método produzirá um erro.
getOnlyItem(): Excel.CustomXmlPart;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.5]
getOnlyItemOrNullObject()
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método retornará null.
getOnlyItemOrNullObject(): Excel.CustomXmlPart;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.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection;Parâmetros
- options
-
Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & 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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomXmlPartScopedCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.CustomXmlPartScopedCollectionData;