Compartilhar 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 folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize códigos de formato especificados aqui: https://msdn.microsoft.com/library/bb225426.aspx.
centerHeader

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

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
leftFooter

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

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

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

O cabeçalho direito da folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

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

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

Detalhes da propriedade

centerFooter

O rodapé central da folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

leftFooter

O rodapé esquerdo da folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 folha de cálculo. Para aplicar a formatação do tipo de letra ou inserir um valor de variável, utilize 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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.HeaderFooter

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.HeaderFooter original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.HeaderFooterData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.HeaderFooterData;

Retornos

Excel.Interfaces.HeaderFooterData