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()	範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -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)	範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -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()

範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -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)

範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。 値は null 、範囲全体に均一なフォント tintAndShade 設定がないことを示します。

setTintAndShade(tintAndShade: number): void;

パラメーター

tintAndShade

number

戻り値

void

setUnderline(underline)

フォントに適用する下線の種類。 詳細は「ExcelScript.RangeUnderlineStyle」をご覧ください。

setUnderline(underline: RangeUnderlineStyle): void;

パラメーター

underline

ExcelScript.RangeUnderlineStyle

戻り値

void