Word.Interfaces.FontUpdateData interface

  • リファレンス
パッケージ:
word

で使用 font.set({ ... })する Font オブジェクトのデータを更新するためのインターフェイス。

プロパティ

bold

フォントが太字かどうかを示す値を指定します。 フォントの書式設定が太字の場合は true、それ以外の場合は false です。
color

指定したフォントの色を指定します。 値は、"#RRGGBB" 形式または色名で指定できます。
doubleStrikeThrough

フォントにダブル取り消し線があるかどうかを示す値を指定します。 フォントの書式が二重取り消し線付きのテキストである場合は true、それ以外の場合は false です。
hidden

フォントが非表示としてタグ付けされているかどうかを示す値を指定します。 True のフォントが非表示のテキストとして書式設定されている場合は、それ以外の場合は false。
highlightColor

強調表示の色を指定します。 これを設定するには、"#RRGGBB" 形式または色名のいずれかの値を使用します。 強調表示の色を削除するには、null に設定します。 返される強調表示の色は、'#RRGGBB' 形式、混合強調表示色の場合は空の文字列、強調表示色がない場合は null にすることができます。 注: Office for Windows Desktop では、既定の強調表示色のみを使用できます。 これらは"Yellow"、"Lime"、"Turquoise"、"Pink"、"Blue"、"Red"、"DarkBlue"、"Teal"、"Green"、"Purple"、"DarkRed"、"Olive"、"Gray"、"LightGray"、"Black" です。 アドインが Office for Windows Desktop で実行されると、フォントに適用されると、その他の色が最も近い色に変換されます。
italic

フォントが斜体かどうかを示す値を指定します。 フォントが斜体の場合は true、それ以外の場合は false です。
name

フォントの名前を表す値を指定します。
size

フォント サイズをポイント単位で表す値を指定します。
strikeThrough

フォントに取り消し線があるかどうかを示す値を指定します。 フォントの書式が取り消し線付きのテキストである場合は true、それ以外の場合は false です。
subscript

フォントが添字であるかどうかを示す値を指定します。 フォントの書式が下付き文字である場合は true、それ以外の場合は false です。
superscript

フォントが上付き文字であるかどうかを示す値を指定します。 フォントの書式が上付き文字である場合は true、それ以外の場合は false です。
underline

フォントの下線の種類を示す値を指定します。 フォントに下線が付いていない場合は 、'None' です。

プロパティの詳細

bold

フォントが太字かどうかを示す値を指定します。 フォントの書式設定が太字の場合は true、それ以外の場合は false です。

bold?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

color

指定したフォントの色を指定します。 値は、"#RRGGBB" 形式または色名で指定できます。

color?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

doubleStrikeThrough

フォントにダブル取り消し線があるかどうかを示す値を指定します。 フォントの書式が二重取り消し線付きのテキストである場合は true、それ以外の場合は false です。

doubleStrikeThrough?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

hidden

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

フォントが非表示としてタグ付けされているかどうかを示す値を指定します。 True のフォントが非表示のテキストとして書式設定されている場合は、それ以外の場合は false。

hidden?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

highlightColor

強調表示の色を指定します。 これを設定するには、"#RRGGBB" 形式または色名のいずれかの値を使用します。 強調表示の色を削除するには、null に設定します。 返される強調表示の色は、'#RRGGBB' 形式、混合強調表示色の場合は空の文字列、強調表示色がない場合は null にすることができます。 注: Office for Windows Desktop では、既定の強調表示色のみを使用できます。 これらは"Yellow"、"Lime"、"Turquoise"、"Pink"、"Blue"、"Red"、"DarkBlue"、"Teal"、"Green"、"Purple"、"DarkRed"、"Olive"、"Gray"、"LightGray"、"Black" です。 アドインが Office for Windows Desktop で実行されると、フォントに適用されると、その他の色が最も近い色に変換されます。

highlightColor?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

italic

フォントが斜体かどうかを示す値を指定します。 フォントが斜体の場合は true、それ以外の場合は false です。

italic?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

name

フォントの名前を表す値を指定します。

name?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

size

フォント サイズをポイント単位で表す値を指定します。

size?: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.1 ]

strikeThrough

フォントに取り消し線があるかどうかを示す値を指定します。 フォントの書式が取り消し線付きのテキストである場合は true、それ以外の場合は false です。

strikeThrough?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

subscript

フォントが添字であるかどうかを示す値を指定します。 フォントの書式が下付き文字である場合は true、それ以外の場合は false です。

subscript?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

superscript

フォントが上付き文字であるかどうかを示す値を指定します。 フォントの書式が上付き文字である場合は true、それ以外の場合は false です。

superscript?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

underline

フォントの下線の種類を示す値を指定します。 フォントに下線が付いていない場合は 、'None' です。

underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

プロパティ値

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

注釈

[ API セット: WordApi 1.1 ]