Excel.RangeFormat class

Especifica se o texto é automaticamente avanço quando o alinhamento do texto é definido como distribuição igual.

autoIndent: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly borders: Excel.RangeBorderCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica a largura de todas as colunas dentro do intervalo. Se as larguras das colunas não forem uniformes, null serão devolvidas.

columnWidth: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

Retorna o objeto de preenchimento definido em todo o intervalo.

readonly fill: Excel.RangeFill;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Retorna o objeto font definido em todo o intervalo.

readonly font: Excel.RangeFont;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

indentLevel: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly protection: Excel.FormatProtection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

A ordem de leitura para o intervalo.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

A altura de todas as linhas no intervalo. Se as alturas das linhas não forem uniformes, null serão devolvidas.

rowHeight: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Especifica se o texto diminui automaticamente para caber na largura da coluna disponível.

shrinkToFit: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

textOrientation: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const 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();
});

Determina se a altura da linha do Range objeto é igual à altura padrão da folha. Devolve true se a altura da linha do Range objeto for igual à altura padrão da folha. Devolve null se o intervalo contiver mais do que uma linha e as linhas não tiverem a mesma altura. Devolve false o contrário. Nota: esta propriedade destina-se apenas a ser definida como true. Defini-lo como false não tem qualquer efeito.

useStandardHeight: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha. Devolve true se a largura da coluna do Range objeto for igual à largura padrão da folha. Devolve null se o intervalo contiver mais do que uma coluna e as colunas não tiverem a mesma altura. Devolve false o contrário. Nota: esta propriedade destina-se apenas a ser definida como true. Defini-lo como false não tem qualquer efeito.

useStandardWidth: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica se o Excel molda o texto no objeto. Um null valor indica que todo o intervalo não tem uma definição de moldagem uniforme

wrapText: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Ajusta o avanço da formatação do intervalo. O valor de avanço varia entre 0 e 250 e é medido em carateres.

adjustIndent(amount: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

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

autofitColumns(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

autofitRows(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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.RangeFormatLoadOptions): Excel.RangeFormat;

Parâmetros

Retornos

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

Parâmetros

Retornos

Exemplos

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.name);
});

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

Parâmetros

Retornos

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.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Excel.RangeFormat): void;

Parâmetros

Retornos

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

toJSON(): Excel.Interfaces.RangeFormatData;

Retornos