Excel.RangeFormat interface

Um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

Propriedades

autoIndent

Especifica se o texto será recuado automaticamente quando o alinhamento do texto for definido como distribuição igual.

borders

Coleção de objetos border que se aplicam a todo o intervalo.

columnWidth

Especifica a largura de todos os colums dentro do intervalo. Se as larguras das colunas não forem uniformes, será retornado null.

fill

Retorna o objeto de preenchimento definido em todo o intervalo.

font

Retorna o objeto font definido em todo o intervalo.

horizontalAlignment

Representa o alinhamento horizontal do objeto especificado. Consulte Excel. HorizontalAlignment para obter detalhes.

indentLevel

Um número inteiro entre 0 e 250 que indica o nível de recuo.

protection

Retorna o objeto de proteção de formato para um intervalo.

readingOrder

A ordem de leitura para o intervalo.

rowHeight

A altura de todas as linhas no intervalo. Se as alturas de linha não forem uniformes, NULL será retornado.

shrinkToFit

Especifica se o texto é automaticamente reduzido para se ajustar à largura de coluna disponível.

textOrientation

A orientação do texto de todas as células dentro do intervalo. A orientação do texto deve ser um inteiro de-90 a 90 ou 180 para texto orientado verticalmente. Se a orientação dentro de um intervalo não for uniforme, NULL será retornado.

useStandardHeight

Determina se a altura da linha do objeto Range é igual a altura padrão da planilha. Retorna true se a altura da linha do objeto Range for igual à altura padrão da planilha. Retorna NULL se o intervalo contiver mais de uma linha e as linhas não forem todas da mesma altura. Caso contrário, retornará false.

useStandardWidth

Especifica se a largura da coluna do objeto Range é igual à largura padrão da planilha. Retorna true se a largura da coluna do objeto Range for igual à largura padrão da planilha. Retorna NULL se o intervalo contiver mais de uma coluna e as colunas não forem todas da mesma altura. Caso contrário, retornará false.

verticalAlignment

Representa o alinhamento vertical do objeto especificado. Consulte Excel. VerticalAlignment para obter detalhes.

wrapText

Especifica se o Excel quebra o texto no objeto. Um valor nulo indica que o intervalo inteiro não tem configuração de quebra de linha automática uniforme.

Métodos

adjustIndent(amount)

Ajusta o recuo da formatação do intervalo. O valor de recuo varia de 0 a 250 e é medido em caracteres.

autofitColumns()

Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitRows()

Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

load(propertyNames)

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

Detalhes da propriedade

autoIndent

Especifica se o texto será recuado automaticamente quando o alinhamento do texto for definido como distribuição igual.

autoIndent: boolean;

Valor da propriedade

boolean

borders

Coleção de objetos border que se aplicam a todo o intervalo.

readonly borders: RangeBorderCollection;

Valor da propriedade

columnWidth

Especifica a largura de todos os colums dentro do intervalo. Se as larguras das colunas não forem uniformes, será retornado null.

columnWidth: number;

Valor da propriedade

number

fill

Retorna o objeto de preenchimento definido em todo o intervalo.

readonly fill: RangeFill;

Valor da propriedade

font

Retorna o objeto font definido em todo o intervalo.

readonly font: RangeFont;

Valor da propriedade

horizontalAlignment

Representa o alinhamento horizontal do objeto especificado. Consulte Excel. HorizontalAlignment para obter detalhes.

horizontalAlignment:
            | HorizontalAlignment
            | "General"
            | "Left"
            | "Center"
            | "Right"
            | "Fill"
            | "Justify"
            | "CenterAcrossSelection"
            | "Distributed";

Valor da propriedade

| HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

indentLevel

Um número inteiro entre 0 e 250 que indica o nível de recuo.

indentLevel: number;

Valor da propriedade

number

protection

Retorna o objeto de proteção de formato para um intervalo.

readonly protection: FormatProtection;

Valor da propriedade

readingOrder

A ordem de leitura para o intervalo.

readingOrder: ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Valor da propriedade

ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

rowHeight

A altura de todas as linhas no intervalo. Se as alturas de linha não forem uniformes, NULL será retornado.

rowHeight: number;

Valor da propriedade

number

shrinkToFit

Especifica se o texto é automaticamente reduzido para se ajustar à largura de coluna disponível.

shrinkToFit: boolean;

Valor da propriedade

boolean

textOrientation

A orientação do texto de todas as células dentro do intervalo. A orientação do texto deve ser um inteiro de-90 a 90 ou 180 para texto orientado verticalmente. Se a orientação dentro de um intervalo não for uniforme, NULL será retornado.

textOrientation: number;

Valor da propriedade

number

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
}

useStandardHeight

Determina se a altura da linha do objeto Range é igual a altura padrão da planilha. Retorna true se a altura da linha do objeto Range for igual à altura padrão da planilha. Retorna NULL se o intervalo contiver mais de uma linha e as linhas não forem todas da mesma altura. Caso contrário, retornará false.

useStandardHeight: boolean;

Valor da propriedade

boolean

useStandardWidth

Especifica se a largura da coluna do objeto Range é igual à largura padrão da planilha. Retorna true se a largura da coluna do objeto Range for igual à largura padrão da planilha. Retorna NULL se o intervalo contiver mais de uma coluna e as colunas não forem todas da mesma altura. Caso contrário, retornará false.

useStandardWidth: boolean;

Valor da propriedade

boolean

verticalAlignment

Representa o alinhamento vertical do objeto especificado. Consulte Excel. VerticalAlignment para obter detalhes.

verticalAlignment:
            | VerticalAlignment
            | "Top"
            | "Center"
            | "Bottom"
            | "Justify"
            | "Distributed";

Valor da propriedade

| VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

wrapText

Especifica se o Excel quebra o texto no objeto. Um valor nulo indica que o intervalo inteiro não tem configuração de quebra de linha automática uniforme.

wrapText: boolean;

Valor da propriedade

boolean

Detalhes do método

adjustIndent(amount)

Ajusta o recuo da formatação do intervalo. O valor de recuo varia de 0 a 250 e é medido em caracteres.

adjustIndent(amount: number): void;

Parâmetros

amount
number

O número de espaços de caracteres pelo qual o recuo atual é ajustado. Esse valor deve estar entre-250 e 250. Observação: se o valor aumentar o nível de recuo acima de 250, o nível de recuo permanecerá com 250. Da mesma forma, se o valor diminuir o nível de recuo abaixo de 0, o nível de recuo permanecerá como 0.

Retornos

void

autofitColumns()

Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitColumns(): void;

Retornos

void

autofitRows()

Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitRows(): void;

Retornos

void

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[]): void;

Parâmetros

propertyNames
string | string[]

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

Retornos

void