PowerPoint.ShapeFont class
図形の TextRange オブジェクトのフォント名、フォント サイズ、色などのフォント属性を表します。
- Extends
注釈
[ API セット: PowerPointApi 1.4 ]
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
プロパティ
| bold | フォントの太字の状態を表します。
|
| color | テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。
|
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| italic | フォントの斜体の状態を表します。 'TextRange' に斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、'null' を返します。 |
| name | フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。 |
| size | フォント サイズをポイント単位で表します (例: 11)。 TextRange にサイズの異なるテキストが含まれている場合、null を返します。 |
| underline | フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントが |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
bold
フォントの太字の状態を表します。
TextRangeに太字と太字以外の両方のテキスト フラグメントが含まれている場合は、nullを返します。
bold: boolean;プロパティ値
boolean
注釈
color
テキストの色の HTML カラー コード表現 (例: "#FF0000" は赤を表します)。
TextRangeに異なる色のテキスト フラグメントが含まれている場合は、nullを返します。
color: string;プロパティ値
string
注釈
[ API セット: PowerPointApi 1.4 ]
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
italic
フォントの斜体の状態を表します。 'TextRange' に斜体と非斜体の両方のテキスト フラグメントが含まれている場合は、'null' を返します。
italic: boolean;プロパティ値
boolean
注釈
name
フォント名 ("Calibri" など) を表します。 テキストが複合スクリプトまたは東アジア言語の場合、これは対応するフォント名です。それ以外の場合は、ラテンフォント名です。
name: string;プロパティ値
string
注釈
size
フォント サイズをポイント単位で表します (例: 11)。 TextRange にサイズの異なるテキストが含まれている場合、null を返します。
size: number;プロパティ値
number
注釈
underline
フォントに適用する下線の種類。 下線のスタイルが異なるテキスト フラグメントがTextRangeに含まれている場合は、nullを返します。 詳細については、「 PowerPoint.ShapeFontUnderlineStyle 」を参照してください。
underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";プロパティ値
PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): PowerPoint.ShapeFont;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.ShapeFont;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.ShapeFont オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.ShapeFontData として型指定) を返します。
toJSON(): PowerPoint.Interfaces.ShapeFontData;戻り値
Office Add-ins