Excel.RangeFormat class
Um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| auto |
Especifica se o texto é automaticamente avanço quando o alinhamento do texto é definido como distribuição igual. |
| borders | Coleção de objetos border que se aplicam a todo o intervalo. |
| column |
Especifica a largura de todas as colunas dentro do intervalo. Se as larguras das colunas não forem uniformes, |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| fill | Retorna o objeto de preenchimento definido em todo o intervalo. |
| font | Retorna o objeto font definido em todo o intervalo. |
| horizontal |
Representa o alinhamento horizontal do objeto especificado. Veja |
| indent |
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. |
| reading |
A ordem de leitura para o intervalo. |
| row |
A altura de todas as linhas no intervalo. Se as alturas das linhas não forem uniformes, |
| shrink |
Especifica se o texto diminui automaticamente para caber na largura da coluna disponível. |
| text |
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, |
| use |
Determina se a altura da linha do |
| use |
Especifica se a largura da coluna do |
| vertical |
Representa o alinhamento vertical do objeto especificado. Veja |
| wrap |
Especifica se o Excel molda o texto no objeto. Um |
Métodos
| adjust |
Ajusta o avanço da formatação do intervalo. O valor de avanço varia entre 0 e 250 e é medido em carateres. |
| autofit |
Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas. |
| autofit |
Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| 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 |
Detalhes da propriedade
autoIndent
Especifica se o texto é automaticamente avanço quando o alinhamento do texto é definido como distribuição igual.
autoIndent: boolean;Valor da propriedade
boolean
Comentários
borders
Coleção de objetos border que se aplicam a todo o intervalo.
readonly borders: Excel.RangeBorderCollection;Valor da propriedade
Comentários
columnWidth
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
number
Comentários
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
fill
Retorna o objeto de preenchimento definido em todo o intervalo.
readonly fill: Excel.RangeFill;Valor da propriedade
Comentários
font
Retorna o objeto font definido em todo o intervalo.
readonly font: Excel.RangeFont;Valor da propriedade
Comentários
horizontalAlignment
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
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Comentários
indentLevel
Um número inteiro entre 0 e 250 que indica o nível de recuo.
indentLevel: number;Valor da propriedade
number
Comentários
protection
Retorna o objeto de proteção de formato para um intervalo.
readonly protection: Excel.FormatProtection;Valor da propriedade
Comentários
readingOrder
A ordem de leitura para o intervalo.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Valor da propriedade
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Comentários
rowHeight
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
number
Comentários
shrinkToFit
Especifica se o texto diminui automaticamente para caber na largura da coluna disponível.
shrinkToFit: boolean;Valor da propriedade
boolean
Comentários
textOrientation
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
number
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();
});
useStandardHeight
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
boolean
Comentários
useStandardWidth
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
boolean
Comentários
verticalAlignment
Representa o alinhamento vertical do objeto especificado. Veja Excel.VerticalAlignment para obter detalhes.
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Valor da propriedade
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Comentários
wrapText
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
boolean
Comentários
Detalhes do método
adjustIndent(amount)
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
- amount
-
number
O número de espaços de carateres pelo qual o avanço atual é ajustado. Este valor deve ser entre -250 e 250. Nota: se o valor elevar o nível de avanço acima de 250, o nível de avanço permanecerá com 250. Da mesma forma, se a quantidade baixar o nível de avanço abaixo de 0, o nível de avanço permanecerá 0.
Retornos
void
Comentários
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
Comentários
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
Comentários
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.RangeFormatLoadOptions): Excel.RangeFormat;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
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.RangeFormat;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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);
});
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.RangeFormat;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
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.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.RangeFormatUpdateData
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.RangeFormat): void;Parâmetros
- properties
- Excel.RangeFormat
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.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;