Excel.ShapeFont class
図形の TextRange オブジェクトのフォント名、フォント サイズ、色などのフォント属性を表します。
- Extends
注釈
プロパティ
| bold | フォントの太字の状態を表します。
|
| color | テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。
|
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| italic | フォントの斜体の状態を表します。
|
| name | フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。 |
| size | フォント サイズをポイント単位で表します (例: 11)。
|
| strikethrough | フォントの取り消し線の状態を指定します。
|
| subscript | フォントの添字の状態を指定します。 範囲のすべてのフォントが添字である場合は、 |
| superscript | フォントの上付き文字の状態を指定します。 範囲のすべてのフォントが上付きである場合は、 |
| tint |
範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。
|
| underline | フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントが |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
bold
フォントの太字の状態を表します。
TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。
bold: boolean;プロパティ値
boolean
注釈
color
テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。
TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。
color: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
italic
フォントの斜体の状態を表します。
TextRangeに斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、nullを返します。
italic: boolean;プロパティ値
boolean
注釈
name
フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。
name: string;プロパティ値
string
注釈
size
フォント サイズをポイント単位で表します (例: 11)。
TextRangeに異なるフォント サイズのテキスト フラグメントが含まれている場合は、nullを返します。
size: number;プロパティ値
number
注釈
strikethrough
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
フォントの取り消し線の状態を指定します。
null値は、範囲全体に均一な取り消し線設定がないことを示します。
strikethrough: boolean;プロパティ値
boolean
注釈
subscript
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
フォントの添字の状態を指定します。 範囲のすべてのフォントが添字である場合は、 true を返します。 範囲のすべてのフォントが上付きまたは標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。
subscript: boolean;プロパティ値
boolean
注釈
superscript
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
フォントの上付き文字の状態を指定します。 範囲のすべてのフォントが上付きである場合は、 true を返します。 範囲のすべてのフォントが添字または標準 (上付き文字も下付き文字もない) の場合は、 false を返します。 それ以外の場合は null を返します。
superscript: boolean;プロパティ値
boolean
注釈
tintAndShade
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
範囲フォントの色を明るくまたは暗くする倍精度浮動小数点型 (double) を指定します。 値は -1 (最も暗い) から 1 (最も明るい) の間で、元の色の場合は 0 です。
null値は、範囲全体に均一なフォントtintAndShade設定がないことを示します。
tintAndShade: number;プロパティ値
number
注釈
underline
フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細は「Excel.ShapeFontUnderlineStyle」をご覧ください。
underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";プロパティ値
Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ShapeFont;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeFont;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ShapeFontUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ShapeFont): void;パラメーター
- properties
- Excel.ShapeFont
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ShapeFont オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ShapeFontData として型指定) を返します。
toJSON(): Excel.Interfaces.ShapeFontData;