Excel.PageBreak class

Pacote:

excel

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

columnIndex	Especifica o índice de colunas para a quebra de página.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
rowIndex	Especifica o índice de linhas para a quebra de página.

Métodos

delete()	Exclui um objeto de quebra de página.
getCellAfterBreak()	Obtém a primeira célula após a quebra de página.
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.
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 original Excel.PageBreak é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PageBreakData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

columnIndex

Especifica o índice de colunas para a quebra de página.

readonly columnIndex: number;

Valor da propriedade

number

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

rowIndex

Especifica o índice de linhas para a quebra de página.

readonly rowIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

delete()

Exclui um objeto de quebra de página.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getCellAfterBreak()

Obtém a primeira célula após a quebra de página.

getCellAfterBreak(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.PageBreakLoadOptions): Excel.PageBreak;

Parâmetros

options

Excel.Interfaces.PageBreakLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.PageBreak

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.PageBreak

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

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.PageBreak

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 original Excel.PageBreak é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.PageBreakData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.PageBreakData;

Retornos

Excel.Interfaces.PageBreakData