ExcelScript.ShapeFont interface

パッケージ:

ExcelScript

図形の TextRange オブジェクトのフォント名、フォント サイズ、色などのフォント属性を表します。

注釈

例

/**
 * This sample sets the font of a shape to be bold. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first shape in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const shape = sheet.getShapes()[0];

  // Get the text font from the shape.
  const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
  const shapeTextFont: ExcelScript.ShapeFont = text.getFont();

  // Set the font to be bold.
  shapeTextFont.setBold(true);
}

メソッド

getBold()	フォントの太字の状態を表します。 TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。
getColor()	テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。 TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。
getItalic()	フォントの斜体の状態を表します。 TextRangeに斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、nullを返します。
getName()	フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。
getSize()	フォント サイズをポイント単位で表します (例: 11)。 TextRangeに異なるフォント サイズのテキスト フラグメントが含まれている場合は、nullを返します。
getUnderline()	フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細は「ExcelScript.ShapeFontUnderlineStyle」をご覧ください。
setBold(bold)	フォントの太字の状態を表します。 TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。
setColor(color)	テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。 TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。
setItalic(italic)	フォントの斜体の状態を表します。 TextRangeに斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、nullを返します。
setName(name)	フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。
setSize(size)	フォント サイズをポイント単位で表します (例: 11)。 TextRangeに異なるフォント サイズのテキスト フラグメントが含まれている場合は、nullを返します。
setUnderline(underline)	フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細は「ExcelScript.ShapeFontUnderlineStyle」をご覧ください。

メソッドの詳細

getBold()

フォントの太字の状態を表します。 TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。

getBold(): boolean;

戻り値

boolean

getColor()

テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。 TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。

getColor(): string;

戻り値

string

getItalic()

フォントの斜体の状態を表します。 TextRangeに斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、nullを返します。

getItalic(): boolean;

戻り値

boolean

getName()

フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。

getName(): string;

戻り値

string

getSize()

フォント サイズをポイント単位で表します (例: 11)。 TextRangeに異なるフォント サイズのテキスト フラグメントが含まれている場合は、nullを返します。

getSize(): number;

戻り値

number

getUnderline()

フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細は「ExcelScript.ShapeFontUnderlineStyle」をご覧ください。

getUnderline(): ShapeFontUnderlineStyle;

戻り値

ExcelScript.ShapeFontUnderlineStyle

setBold(bold)

フォントの太字の状態を表します。 TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。

setBold(bold: boolean): void;

パラメーター

bold

boolean

戻り値

void

setColor(color)

テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。 TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。

setColor(color: string): void;

パラメーター

color

string

戻り値

void

setItalic(italic)

フォントの斜体の状態を表します。 TextRangeに斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、nullを返します。

setItalic(italic: boolean): void;

パラメーター

italic

boolean

戻り値

void

setName(name)

フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。

setName(name: string): void;

パラメーター

name

string

戻り値

void

setSize(size)

フォント サイズをポイント単位で表します (例: 11)。 TextRangeに異なるフォント サイズのテキスト フラグメントが含まれている場合は、nullを返します。

setSize(size: number): void;

パラメーター

size

number

戻り値

void

setUnderline(underline)

フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細は「ExcelScript.ShapeFontUnderlineStyle」をご覧ください。

setUnderline(underline: ShapeFontUnderlineStyle): void;

パラメーター

underline

ExcelScript.ShapeFontUnderlineStyle

戻り値

void