Share via

Excel.HeaderFooter class

  • Referência
Pacote:
excel
Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

centerFooter

O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
centerHeader

O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
leftFooter

O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
leftHeader

O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
rightFooter

O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
rightHeader

O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

Métodos

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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.HeaderFooter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.HeaderFooterData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

centerFooter

O rodapé central da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

centerFooter: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

centerHeader

O cabeçalho central da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

centerHeader: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Excel.RequestContext

leftFooter

O rodapé esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

leftFooter: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

leftHeader

O cabeçalho esquerdo da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

leftHeader: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

rightFooter

O rodapé direito da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

rightFooter: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

rightHeader

O cabeçalho direito da planilha. Para aplicar a formatação de fonte ou inserir um valor variável, use códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.

rightHeader: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

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.HeaderFooterLoadOptions): Excel.HeaderFooter;

Parâmetros

options
Excel.Interfaces.HeaderFooterLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.HeaderFooter

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.HeaderFooter;

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.HeaderFooter

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.HeaderFooter;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.HeaderFooter

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.HeaderFooterUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.HeaderFooterUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.HeaderFooter): void;

Parâmetros

properties
Excel.HeaderFooter

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.HeaderFooter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.HeaderFooterData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.HeaderFooterData;

Retornos

Excel.Interfaces.HeaderFooterData