ExcelScript.RangeFont interface

Пакет:

ExcelScript

Этот объект представляет атрибуты шрифта (имя, размер, цвет и т. д.) для объекта.

Комментарии

Примеры

/**
 * This script sets the font of A1 to Arial, size 16.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.
  const cellFont = cell.getFormat().getFont();
  cellFont.setName("Arial");
  cellFont.setSize(16);
}

Методы

getBold()	Представляет состояние шрифта полужирным шрифтом.
getColor()	Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
getItalic()	Указывает курсивное состояние шрифта.
getName()	Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.
getSize()	размер шрифта
getStrikethrough()	Указывает состояние зачеркиния шрифта. Значение null указывает, что для всего диапазона не задано однородное зачеркивное значение.
getSubscript()	Указывает состояние подстрочного индекса шрифта. Возвращает значение true , если все шрифты диапазона являются подстрочными. Возвращает значение false , если все шрифты диапазона являются надстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
getSuperscript()	Указывает надстрочный индекс шрифта. Возвращает значение true , если все шрифты диапазона являются надстрочными. Возвращает значение false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
getTintAndShade()	Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что для всего диапазона не задано однородное значение шрифта tintAndShade .
getUnderline()	Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой ExcelScript.RangeUnderlineStyle статье.
setBold(bold)	Представляет состояние шрифта полужирным шрифтом.
setColor(color)	Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
setItalic(italic)	Указывает курсивное состояние шрифта.
setName(name)	Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.
setSize(size)	размер шрифта
setStrikethrough(strikethrough)	Указывает состояние зачеркиния шрифта. Значение null указывает, что для всего диапазона не задано однородное зачеркивное значение.
setSubscript(subscript)	Указывает состояние подстрочного индекса шрифта. Возвращает значение true , если все шрифты диапазона являются подстрочными. Возвращает значение false , если все шрифты диапазона являются надстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
setSuperscript(superscript)	Указывает надстрочный индекс шрифта. Возвращает значение true , если все шрифты диапазона являются надстрочными. Возвращает значение false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
setTintAndShade(tintAndShade)	Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что для всего диапазона не задано однородное значение шрифта tintAndShade .
setUnderline(underline)	Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой ExcelScript.RangeUnderlineStyle статье.

Сведения о методе

getBold()

Представляет состояние шрифта полужирным шрифтом.

getBold(): boolean;

Возвращаемое значение

boolean

getColor()

Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).

getColor(): string;

Возвращаемое значение

string

getItalic()

Указывает курсивное состояние шрифта.

getItalic(): boolean;

Возвращаемое значение

boolean

getName()

Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.

getName(): string;

Возвращаемое значение

string

getSize()

размер шрифта

getSize(): number;

Возвращаемое значение

number

getStrikethrough()

Указывает состояние зачеркиния шрифта. Значение null указывает, что для всего диапазона не задано однородное зачеркивное значение.

getStrikethrough(): boolean;

Возвращаемое значение

boolean

getSubscript()

Указывает состояние подстрочного индекса шрифта. Возвращает значение true , если все шрифты диапазона являются подстрочными. Возвращает значение false , если все шрифты диапазона являются надстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .

getSubscript(): boolean;

Возвращаемое значение

boolean

getSuperscript()

Указывает надстрочный индекс шрифта. Возвращает значение true , если все шрифты диапазона являются надстрочными. Возвращает значение false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .

getSuperscript(): boolean;

Возвращаемое значение

boolean

getTintAndShade()

Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что для всего диапазона не задано однородное значение шрифта tintAndShade .

getTintAndShade(): number;

Возвращаемое значение

number

getUnderline()

Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой ExcelScript.RangeUnderlineStyle статье.

getUnderline(): RangeUnderlineStyle;

Возвращаемое значение

ExcelScript.RangeUnderlineStyle

setBold(bold)

Представляет состояние шрифта полужирным шрифтом.

setBold(bold: boolean): void;

Параметры

bold

boolean

Возвращаемое значение

void

Примеры

/**
 * This script bolds the text of cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Bold the font for that cell
  cell.getFormat().getFont().setBold(true);
}

setColor(color)

Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).

setColor(color: string): void;

Параметры

color

string

Возвращаемое значение

void

setItalic(italic)

Указывает курсивное состояние шрифта.

setItalic(italic: boolean): void;

Параметры

italic

boolean

Возвращаемое значение

void

setName(name)

Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.

setName(name: string): void;

Параметры

name

string

Возвращаемое значение

void

Примеры

/**
 * This script sets the font style of A1 to Arial.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.
  cell.getFormat().getFont().setName("Arial");
}

setSize(size)

размер шрифта

setSize(size: number): void;

Параметры

size

number

Возвращаемое значение

void

Примеры

/**
 * This script sets the font size of A1 to 16.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Adjust the font settings for that cell.clear
  cell.getFormat().getFont().setSize(16);
}

setStrikethrough(strikethrough)

Указывает состояние зачеркиния шрифта. Значение null указывает, что для всего диапазона не задано однородное зачеркивное значение.

setStrikethrough(strikethrough: boolean): void;

Параметры

strikethrough

boolean

Возвращаемое значение

void

setSubscript(subscript)

Указывает состояние подстрочного индекса шрифта. Возвращает значение true , если все шрифты диапазона являются подстрочными. Возвращает значение false , если все шрифты диапазона являются надстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .

setSubscript(subscript: boolean): void;

Параметры

subscript

boolean

Возвращаемое значение

void

setSuperscript(superscript)

Указывает надстрочный индекс шрифта. Возвращает значение true , если все шрифты диапазона являются надстрочными. Возвращает значение false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .

setSuperscript(superscript: boolean): void;

Параметры

superscript

boolean

Возвращаемое значение

void

setTintAndShade(tintAndShade)

Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что для всего диапазона не задано однородное значение шрифта tintAndShade .

setTintAndShade(tintAndShade: number): void;

Параметры

tintAndShade

number

Возвращаемое значение

void

setUnderline(underline)

Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой ExcelScript.RangeUnderlineStyle статье.

setUnderline(underline: RangeUnderlineStyle): void;

Параметры

underline

ExcelScript.RangeUnderlineStyle

Возвращаемое значение

void