Excel.WorksheetFreezePanes class

Pacote:
excel
Extends
OfficeExtension.ClientObject

Comentários

[Conjunto de apis: ExcelApi 1.7]

Propriedades

context

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

Métodos

freezeAt(frozenRange)

Define as células congeladas no modo de exibição da planilha ativa. O intervalo fornecido corresponde às células que serão congeladas no painel superior e esquerdo.
freezeColumns(count)

Congele a primeira coluna ou colunas da planilha no lugar.
freezeRows(count)

Congele as linhas superiores da planilha no lugar.
getLocation()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células congeladas no painel superior e esquerdo.
getLocationOrNullObject()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células congeladas no painel superior e esquerdo. Se não houver nenhum painel congelado, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
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.WorksheetFreezePanes é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetFreezePanesData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
unfreeze()

Remove todos os painéis congelados na planilha.

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

Excel.RequestContext

Detalhes do método

freezeAt(frozenRange)

Define as células congeladas no modo de exibição da planilha ativa. O intervalo fornecido corresponde às células que serão congeladas no painel superior e esquerdo.

freezeAt(frozenRange: Range | string): void;

Parâmetros

frozenRange

Excel.Range | string

Um intervalo que representa as células a serem congeladas ou null que remove todos os painéis congelados.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.7]

freezeColumns(count)

Congele a primeira coluna ou colunas da planilha no lugar.

freezeColumns(count?: number): void;

Parâmetros

count

number

Número opcional de colunas a serem congeladas ou zero para descongelar todas as colunas

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.7]

freezeRows(count)

Congele as linhas superiores da planilha no lugar.

freezeRows(count?: number): void;

Parâmetros

count

number

Número opcional de linhas a serem congeladas ou zero para descongelar todas as linhas

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.7]

getLocation()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células congeladas no painel superior e esquerdo.

getLocation(): Excel.Range;

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.7]

getLocationOrNullObject()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células congeladas no painel superior e esquerdo. Se não houver nenhum painel congelado, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getLocationOrNullObject(): Excel.Range;

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.7]

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.WorksheetFreezePanes é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetFreezePanesData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): {
            [key: string]: string;
        };

Retornos

{ [key: string]: string; }

unfreeze()

Remove todos os painéis congelados na planilha.

unfreeze(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.7]