Word.Interfaces.FontUpdateData interface

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

注釈

使用元

プロパティ

allCaps

フォントをすべて大文字として書式設定するかどうかを指定します。つまり、小文字は大文字として表示されます。 次の値が示される可能性があります。

  • true : すべてのテキストに All Caps 属性があります。

  • false : いずれのテキストにも All Caps 属性がありません。

  • null : テキストのすべてではなく一部に All Caps 属性がある場合は返されます。

bold

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

boldBidirectional

右から左の言語ドキュメントでフォントを太字として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストが太字で表示されます。

  • false : 太字のテキストはありません。

  • null : テキストのすべてではなく一部が太字の場合に返されます。

color

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

colorIndex

フォントの色を表す ColorIndex 値を指定します。

colorIndexBidirectional

右から左に記述する言語ドキュメントの Font オブジェクトの色を指定します。

contextualAlternates

フォントに対してコンテキスト代替を有効にするかどうかを指定します。

diacriticColor

Font オブジェクトの Diacritic に使用する色を指定します。 値は '#RRGGBB' 形式で指定できます。

disableCharacterSpaceGrid

対応する Font オブジェクトの 1 行あたりの文字数を Microsoft Word が無視するかどうかを指定します。

doubleStrikeThrough

フォントに取り消し線を付けるかどうかを指定します。 true フォントが取り消し線テキストとして書式設定されている場合は、それ以外の場合は false

emboss

フォントをエンボス加工として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストがエンボス加工されています。

  • false : どのテキストもエンボス加工されていません。

  • null : テキストのすべてではなく一部がエンボス加工されている場合は返されます。

emphasisMark

文字または指定文字列の強調記号を表す EmphasisMark 値を指定します。

engrave

フォントを彫刻として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true :すべてのテキストが刻印されます。

  • false : テキストは刻印されません。

  • null : テキストのすべてではなく一部が刻印されている場合は返されます。

fill

テキスト範囲で使用されるフォントの塗りつぶしの書式設定プロパティが含まれる FillFormat オブジェクトを返します。

glow

テキスト範囲で使用されるフォントの光彩書式を表す GlowFormat オブジェクトを返します。

hidden

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

highlightColor

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

italic

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

italicBidirectional

右から左の言語ドキュメントでフォントを斜体にするかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストが斜体になります。

  • false : どのテキストも斜体ではありません。

  • null : テキストのすべてではなく一部が斜体になっている場合は返されます。

kerning

Microsoft Word がカーニングを自動的に調整する最小フォント サイズを指定します。

ligature

Font オブジェクトの合字設定を指定します。

line

行の書式を指定する LineFormat オブジェクトを返します。

name

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

nameAscii

ラテン文字のテキスト (文字コードが 0 から 127 までの文字) に使用されるフォントを指定します。

nameBidirectional

右から左に記述する言語ドキュメントのフォント名を指定します。

nameFarEast

東アジア言語のフォント名を指定します。

nameOther

128 から 255 までのコードを持つ文字に使用するフォントを指定します。

numberForm

OpenType フォントの数字の書式設定を指定します。

numberSpacing

フォントの番号間隔の設定を指定します。

outline

フォントをアウトラインとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストがアウトラインされます。

  • false : テキストの輪郭は表示されません。

  • null : テキストのすべてではなく一部がアウトラインされている場合は返されます。

position

基準行に対するテキストの位置をポイント単位で指定します。

reflection

図形のリフレクション書式を表す ReflectionFormat オブジェクトを返します。

scaling

フォントに適用されるスケーリングのパーセンテージを指定します。

shadow

フォントを影付きとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストに影が付きます。

  • false : どのテキストも影になりません。

  • null : テキストのすべてではなく一部がシャドウになっている場合に返されます。

size

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

sizeBidirectional

右から左に記述するテキストのフォント サイズをポイント単位で指定します。

smallCaps

小文字が小文字として表示されるように、フォントを小文字として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストに Small Caps 属性があります。

  • false : どのテキストにも Small Caps 属性がありません。

  • null : テキストのすべてではなく一部に Small Caps 属性がある場合は返されます。

spacing

文字間の間隔を指定します。

strikeThrough

フォントに取り消し線を使用するかどうかを指定します。 true フォントが取り消し線テキストとして書式設定されている場合は、それ以外の場合は false

stylisticSet

フォントのスタイル セットを指定します。

subscript

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

superscript

フォントを上付き文字にするかどうかを指定します。 true フォントが上付き文字として書式設定されている場合は false

textColor

フォントの色を表す ColorFormat オブジェクトを返します。

textShadow

フォントの影の書式を指定する ShadowFormat オブジェクトを返します。

threeDimensionalFormat

フォントの 3 次元 (3D) 効果の書式設定プロパティを含む ThreeDimensionalFormat オブジェクトを返します。

underline

フォントの下線の種類を指定します。 none フォントに下線が付いていない場合。

underlineColor

Font オブジェクトの下線の色を指定します。 値は '#RRGGBB' 形式で指定できます。

プロパティの詳細

allCaps

フォントをすべて大文字として書式設定するかどうかを指定します。つまり、小文字は大文字として表示されます。 次の値が示される可能性があります。

  • true : すべてのテキストに All Caps 属性があります。

  • false : いずれのテキストにも All Caps 属性がありません。

  • null : テキストのすべてではなく一部に All Caps 属性がある場合は返されます。

allCaps?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

bold

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

bold?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

boldBidirectional

右から左の言語ドキュメントでフォントを太字として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストが太字で表示されます。

  • false : 太字のテキストはありません。

  • null : テキストのすべてではなく一部が太字の場合に返されます。

boldBidirectional?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

color

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

color?: string;

プロパティ値

string

注釈

API セット: WordApi 1.1

colorIndex

フォントの色を表す ColorIndex 値を指定します。

colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

プロパティ値

Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"

注釈

API セット: WordApiDesktop 1.3

colorIndexBidirectional

右から左に記述する言語ドキュメントの Font オブジェクトの色を指定します。

colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

プロパティ値

Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"

注釈

API セット: WordApiDesktop 1.3

contextualAlternates

フォントに対してコンテキスト代替を有効にするかどうかを指定します。

contextualAlternates?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

diacriticColor

Font オブジェクトの Diacritic に使用する色を指定します。 値は '#RRGGBB' 形式で指定できます。

diacriticColor?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

disableCharacterSpaceGrid

対応する Font オブジェクトの 1 行あたりの文字数を Microsoft Word が無視するかどうかを指定します。

disableCharacterSpaceGrid?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

doubleStrikeThrough

フォントに取り消し線を付けるかどうかを指定します。 true フォントが取り消し線テキストとして書式設定されている場合は、それ以外の場合は false

doubleStrikeThrough?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

emboss

フォントをエンボス加工として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストがエンボス加工されています。

  • false : どのテキストもエンボス加工されていません。

  • null : テキストのすべてではなく一部がエンボス加工されている場合は返されます。

emboss?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

emphasisMark

文字または指定文字列の強調記号を表す EmphasisMark 値を指定します。

emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

プロパティ値

Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"

注釈

API セット: WordApiDesktop 1.3

engrave

フォントを彫刻として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true :すべてのテキストが刻印されます。

  • false : テキストは刻印されません。

  • null : テキストのすべてではなく一部が刻印されている場合は返されます。

engrave?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

fill

テキスト範囲で使用されるフォントの塗りつぶしの書式設定プロパティが含まれる FillFormat オブジェクトを返します。

fill?: Word.Interfaces.FillFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

glow

テキスト範囲で使用されるフォントの光彩書式を表す GlowFormat オブジェクトを返します。

glow?: Word.Interfaces.GlowFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

hidden

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

hidden?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

highlightColor

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

highlightColor?: string;

プロパティ値

string

注釈

API セット: WordApi 1.1

italic

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

italic?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

italicBidirectional

右から左の言語ドキュメントでフォントを斜体にするかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストが斜体になります。

  • false : どのテキストも斜体ではありません。

  • null : テキストのすべてではなく一部が斜体になっている場合は返されます。

italicBidirectional?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

kerning

Microsoft Word がカーニングを自動的に調整する最小フォント サイズを指定します。

kerning?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

ligature

Font オブジェクトの合字設定を指定します。

ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

プロパティ値

Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"

注釈

API セット: WordApiDesktop 1.3

line

行の書式を指定する LineFormat オブジェクトを返します。

line?: Word.Interfaces.LineFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

name

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

name?: string;

プロパティ値

string

注釈

API セット: WordApi 1.1

nameAscii

ラテン文字のテキスト (文字コードが 0 から 127 までの文字) に使用されるフォントを指定します。

nameAscii?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

nameBidirectional

右から左に記述する言語ドキュメントのフォント名を指定します。

nameBidirectional?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

nameFarEast

東アジア言語のフォント名を指定します。

nameFarEast?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

nameOther

128 から 255 までのコードを持つ文字に使用するフォントを指定します。

nameOther?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

numberForm

OpenType フォントの数字の書式設定を指定します。

numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle";

プロパティ値

Word.NumberForm | "Default" | "Lining" | "OldStyle"

注釈

API セット: WordApiDesktop 1.3

numberSpacing

フォントの番号間隔の設定を指定します。

numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

プロパティ値

Word.NumberSpacing | "Default" | "Proportional" | "Tabular"

注釈

API セット: WordApiDesktop 1.3

outline

フォントをアウトラインとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストがアウトラインされます。

  • false : テキストの輪郭は表示されません。

  • null : テキストのすべてではなく一部がアウトラインされている場合は返されます。

outline?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

position

基準行に対するテキストの位置をポイント単位で指定します。

position?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

reflection

図形のリフレクション書式を表す ReflectionFormat オブジェクトを返します。

reflection?: Word.Interfaces.ReflectionFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

scaling

フォントに適用されるスケーリングのパーセンテージを指定します。

scaling?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

shadow

フォントを影付きとして書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストに影が付きます。

  • false : どのテキストも影になりません。

  • null : テキストのすべてではなく一部がシャドウになっている場合に返されます。

shadow?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

size

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

size?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

sizeBidirectional

右から左に記述するテキストのフォント サイズをポイント単位で指定します。

sizeBidirectional?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

smallCaps

小文字が小文字として表示されるように、フォントを小文字として書式設定するかどうかを指定します。 次の値が示される可能性があります。

  • true : すべてのテキストに Small Caps 属性があります。

  • false : どのテキストにも Small Caps 属性がありません。

  • null : テキストのすべてではなく一部に Small Caps 属性がある場合は返されます。

smallCaps?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

spacing

文字間の間隔を指定します。

spacing?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.3

strikeThrough

フォントに取り消し線を使用するかどうかを指定します。 true フォントが取り消し線テキストとして書式設定されている場合は、それ以外の場合は false

strikeThrough?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

stylisticSet

フォントのスタイル セットを指定します。

stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

プロパティ値

Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"

注釈

API セット: WordApiDesktop 1.3

subscript

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

subscript?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

superscript

フォントを上付き文字にするかどうかを指定します。 true フォントが上付き文字として書式設定されている場合は false

superscript?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

textColor

フォントの色を表す ColorFormat オブジェクトを返します。

textColor?: Word.Interfaces.ColorFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

textShadow

フォントの影の書式を指定する ShadowFormat オブジェクトを返します。

textShadow?: Word.Interfaces.ShadowFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

threeDimensionalFormat

フォントの 3 次元 (3D) 効果の書式設定プロパティを含む ThreeDimensionalFormat オブジェクトを返します。

threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

underlineColor

Font オブジェクトの下線の色を指定します。 値は '#RRGGBB' 形式で指定できます。

underlineColor?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3