Excel.ShapeFont class
図形の TextRange オブジェクトのフォント名、フォント サイズ、色などのフォント属性を表します。
- Extends
プロパティ
| bold | フォントの太字の状態を表します。
|
| color | テキスト色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。
|
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| italic | フォントの斜体の状態を表します。
|
| name | フォント名を表します (例: "Calibri")。 テキストが複合文字または東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテン語のフォント名です。 |
| size | フォント サイズをポイント単位で表します (例: 11)。
|
| strikethrough | フォントの取り消し線の状態を指定します。
|
| subscript | フォントの下付き文字の状態を指定します。 範囲内のすべてのフォントが下付き文字の場合に |
| superscript | フォントの上付き文字の状態を指定します。 範囲内のすべてのフォントが上付き文字の場合に |
| tint |
範囲フォントの色を明るくするか暗くする倍精度浮動小数点値を指定します。 値は -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 は運用環境で使用しないでください。
範囲フォントの色を明るくするか暗くする倍精度浮動小数点値を指定します。 値は -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
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
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;