Win32 API 日本語リファレンス
ホーム › UI.Controls.RichEdit › ITextFont

ITextFont

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID8cc497c3-a1df-11ce-8098-00aa0047be5d継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

Text Object Model (TOM) のリッチテキスト範囲の属性は、ITextFont と ITextPara という 2 つのデュアルインターフェイスを通じてアクセスします。(ITextFont)

解説(Remarks)

ITextFont インターフェイスと ITextPara インターフェイスは、それぞれ Microsoft Word の書式設定の フォント ダイアログボックスと 段落 ダイアログボックスの機能をカプセル化したものです。どちらのインターフェイスも、範囲オブジェクトの属性の複製を返したり、一連の属性を範囲に転送したりできる複製 (Value) プロパティを備えています。このため、これらはプログラム可能な書式のコピーツールのように機能します。たとえば次のサブルーチンを使用すると、範囲 r1 のすべての属性を範囲 r2 に転送しつつ、r2 を太字にしてフォントサイズを 12 ポイントにする、といった操作を行えます。

Sub AttributeCopy(r1 As ITextRange, r2 As ITextRange)
    Dim tf As ITextFont
    tf = r1.Font                ' Value is the default property    
    tf.Bold = tomTrue           ' You can make some modifications
    tf.Size = 12
    tf.Animation = tomSparkleText
    r2.Font = tf                ' Apply font attributes all at once
End Sub

C++ で記述された同様の例については、SetFont を参照してください。

ITextFont 属性インターフェイスは、プロパティを設定する従来の Microsoft Visual Basic for Applications (VBA) の方法を表しており、望ましい VBA の記法を提供します。

ITextFont は、2 値の状態を持つリッチテキスト属性に対して "tomBool" 型を使用します。詳細については、The tomBool Type を参照してください。

リッチエディットコントロールは、TOM を通じても RTF (Rich Text Format) コンバーターを通じても、すべての ITextFont プロパティをそのまま、つまり変更せずに受け取って返すことができます。ただし、All Caps、Animation、Embossed、Imprint、Shadow、Small Caps、Hidden、Kerning、Outline、Style の各フォントプロパティは表示できません。

メソッド 55

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT GetDuplicate(ITextFont** ppFont)

このテキストフォントオブジェクトの複製を取得します。

ppFontITextFont**out複製されたテキストフォントオブジェクトです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_OUTOFMEMORY
 新しいオブジェクトのためにメモリを割り当てられませんでした。
E_INVALIDARG
 メソッドに無効な引数が含まれています。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

複製プロパティは、ITextFont オブジェクトの既定のプロパティです。

フォントの複製の使用例については、SetFont を参照してください。

vtbl 8 HRESULT SetDuplicate(ITextFont* pFont)

別のテキストフォントオブジェクトをコピーして文字書式を設定します。

pFontITextFont*inoptionalこのフォントオブジェクトに適用するテキストフォントオブジェクトです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

tomUndefined 属性を持つ値は効果がありません。

フォントの複製の使用例については、SetFont を参照してください。

vtbl 9 HRESULT CanChange(INT* pValue)

フォントを変更できるかどうかを判定します。

pValueINT*outフォントを変更できる場合は tomTrue、変更できない場合は tomFalse となる変数です。このパラメーターには NULL を指定できます。

戻り値

型: HRESULT

フォントを変更できる場合、このメソッドは S_OK を返します。失敗した場合は、次の COM エラーコードを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
S_FALSE
 フォントを変更できません。

解説(Remarks)

*pbCanChange は、フォントを変更できる場合にのみ tomTrue を返します。つまり、関連付けられた範囲のどの部分も保護されておらず、関連付けられたドキュメントが読み取り専用でない場合です。この ITextFont オブジェクトが複製である場合、保護規則は適用されません。

vtbl 10 HRESULT IsEqual(ITextFont* pFont, INT* pValue)

このテキストフォントオブジェクトが、指定したテキストフォントオブジェクトと同じプロパティを持つかどうかを判定します。(ITextFont.IsEqual)

pFontITextFont*inoptional比較対象のテキストフォントオブジェクトです。
pValueINT*outフォントオブジェクトが同じプロパティを持つ場合は tomTrue、そうでない場合は tomFalse となる変数です。このパラメーターには NULL を指定できます。

戻り値

型: HRESULT

テキストフォントオブジェクトが同じプロパティを持つ場合、このメソッドは成功して S_OK を返します。テキストフォントオブジェクトが同じプロパティを持たない場合、このメソッドは失敗して S_FALSE を返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

解説(Remarks)

テキストフォントオブジェクトが等しいのは、pFont が現在のフォントオブジェクトと同じ Text Object Model (TOM) オブジェクトに属している場合に限られます。ITextFont::IsEqual メソッドは、いずれかのフォントオブジェクトが tomUndefined を持つエントリを無視します。

vtbl 11 HRESULT Reset(tomConstants Value)

文字書式を指定した値にリセットします。

ValuetomConstantsin

リセットの種類です。このパラメーターには、次の値の組み合わせを指定できます。

値 意味
tomDefault
 このフォントオブジェクトが範囲にアタッチされている場合は、ドキュメントの既定の文字書式に設定します。それ以外の場合は、基本的な TOM エンジンの既定値に設定します。
tomUndefined
 すべてのプロパティを未定義の値に設定します。この値は、複製 (クローン) フォントオブジェクトに対してのみ有効です。
tomApplyLater
 プロパティ値の設定を許可しますが、アタッチされた範囲にはまだ適用しません。
tomApplyNow
 現在のプロパティをアタッチされた範囲に適用します。
tomCacheParms
 現在のフォントを、アタッチされた範囲のプロパティで更新しません。
tomTrackParms
 現在のフォントを、アタッチされた範囲のプロパティで更新します。
tomApplyTmp
 一時的な書式を適用します。
tomDisableSmartFont
 スマートフォントを適用しません。
tomEnableSmartFont
 スマートフォントを適用します。
tomUsePoints
 浮動小数点の測定にポイントを使用します。
tomUseTwips
 浮動小数点の測定に twip を使用します。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
S_FALSE
 変更から保護されています。
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

ITextFont::Reset を tomUndefined を指定して呼び出すと、すべてのプロパティが未定義の値に設定されます。したがって、フォントオブジェクトを範囲に適用しても何も変わりません。これは、ITextFont::GetDuplicate メソッドで取得したフォントオブジェクトに当てはまります。

vtbl 12 HRESULT GetStyle(INT* pValue)

範囲内の文字の文字スタイルハンドルを取得します。

pValueINT*out文字スタイルハンドルです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
 

COM のエラーコードの詳細については、Error Handling in COM を参照してください。

解説(Remarks)

Text Object Model (TOM) バージョン 1.0 では、スタイルハンドルの意味は規定されていません。その意味は、TOM を実装するテキストシステムの他の機能に依存します。

vtbl 13 HRESULT SetStyle(INT Value)

範囲内の文字の文字スタイルハンドルを設定します。

ValueINTin新しい文字スタイルハンドルです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

Text Object Model (TOM) バージョン 1.0 では、スタイルハンドルの意味は規定されていません。その意味は、TOM を実装するテキストシステムの他の機能に依存します。

vtbl 14 HRESULT GetAllCaps(INT* pValue)

文字がすべて大文字かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字がすべて大文字です。
tomFalse 文字がすべて大文字ではありません。
tomUndefined AllCaps プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 メソッドに無効な引数が指定されました。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_ALLCAPS 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 15 HRESULT SetAllCaps(INT Value)

文字をすべて大文字にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字がすべて大文字です。
tomFalse 文字がすべて大文字ではありません。
tomToggle AllCaps プロパティの状態を切り替えます。
tomUndefined AllCaps プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 16 HRESULT GetAnimation(INT* pValue)

アニメーションの種類を取得します。

pValueINT*out

次のアニメーションの種類のいずれかです。

tomNoAnimation tomLasVegasLights tomBlinkingBackground tomSparkleText tomMarchingBlackAnts tomMarchingRedAnts tomShimmer tomWipeDown tomWipeRight

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 17 HRESULT SetAnimation(INT Value)

アニメーションの種類を設定します。

ValueINTin

アニメーションの種類です。次の値のいずれかを指定できます。

アニメーションの種類 値
tomNoAnimation 0
tomLasVegasLights 1
tomBlinkingBackground 2
tomSparkleText 3
tomMarchingBlackAnts 4
tomMarchingRedAnts 5
tomShimmer 6
tomWipeDown 7
tomWipeRight 8

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
vtbl 18 HRESULT GetBackColor(INT* pValue)

テキストの背景 (ハイライト) 色を取得します。

pValueINT*out

テキストの背景色です。次の値のいずれかを指定できます。

値 意味
COLORREF 値 上位バイトが 0 で、下位 3 バイトが RGB カラーを指定します。
PALETTEINDEX によって返される値 上位バイトが 1 で、LOWORD が論理カラーパレットエントリのインデックスを指定します。
tomAutocolor (-9999997) 範囲がシステムの既定の背景色を使用することを示します。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 19 HRESULT SetBackColor(INT Value)

背景色を設定します。

ValueINTin

新しい背景色です。次のいずれかを指定できます。

値 意味
COLORREF 値。 RGB カラーです。
PALETTEINDEX によって返される値 パレットインデックスです。
tomUndefined 変更しません。
tomAutoColor 既定の背景色を使用します。
 

Value に RGB カラーを指定する場合は、RGB マクロを使用して COLORREF を生成します。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 20 HRESULT GetBold(INT* pValue)

文字が太字かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が太字です。
tomFalse 文字が太字ではありません。
tomUndefined Bold プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

ITextFont::SetWeight メソッドと ITextFont::GetWeight メソッドを使用すると、ITextFont::SetBold メソッドや ITextFont::GetBold メソッドよりも精密にフォントの太さを設定・取得できます。

vtbl 21 HRESULT SetBold(INT Value)

文字を太字にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が太字です。
tomFalse 文字が太字ではありません。
tomToggle Bold プロパティの状態を切り替えます。
tomUndefined Bold プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 22 HRESULT GetEmboss(INT* pValue)

文字が浮き彫り (エンボス) かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が浮き彫り (エンボス) です。
tomFalse 文字が浮き彫り (エンボス) ではありません。
tomUndefined Emboss プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_EMBOSS 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 23 HRESULT SetEmboss(INT Value)

文字を浮き彫り (エンボス) にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が浮き彫り (エンボス) です。
tomFalse 文字が浮き彫り (エンボス) ではありません。
tomToggle Emboss プロパティの状態を切り替えます。
tomUndefined Emboss プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 24 HRESULT GetForeColor(INT* pValue)

前景色 (テキストの色) を取得します。

pValueINT*out

前景色です。次の値のいずれかを指定できます。

値 意味
COLORREF 値 上位バイトが 0 で、下位 3 バイトが RGB カラーを指定します。
PALETTEINDEX によって返される値 上位バイトが 1 で、LOWORD が論理カラーパレットエントリのインデックスを指定します。
tomAutocolor (-9999997) 範囲がシステムの既定の前景色を使用することを示します。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 25 HRESULT SetForeColor(INT Value)

前景色 (テキストの色) を設定します。

ValueINTin

新しい前景色です。次のいずれかを指定できます。

値 意味
COLORREF 値。 RGB カラーです。
PALETTEINDEX によって返される値 パレットインデックスです。
tomUndefined 変更しません。
tomAutoColor 既定の前景色を使用します。
 

Value に RGB カラーを指定する場合は、RGB マクロを使用して COLORREF を生成します。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 26 HRESULT GetHidden(INT* pValue)

文字が非表示かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が非表示です。
tomFalse 文字が非表示ではありません。
tomUndefined Hidden プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_HIDDEN 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 27 HRESULT SetHidden(INT Value)

文字を非表示にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が非表示です。
tomFalse 文字が非表示ではありません。
tomToggle Hidden プロパティの状態を切り替えます。
tomUndefined Hidden プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 28 HRESULT GetEngrave(INT* pValue)

文字が刻印文字として表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が刻印文字として表示されます。
tomFalse 文字が刻印文字として表示されません。
tomUndefined Engrave プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_IMPRINT 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 29 HRESULT SetEngrave(INT Value)

文字を刻印文字として表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が刻印されています。
tomFalse 文字が刻印されていません。
tomToggle Engrave プロパティの状態を切り替えます。
tomUndefined Engrave プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 30 HRESULT GetItalic(INT* pValue)

文字が斜体 (イタリック) かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が斜体 (イタリック) です。
tomFalse 文字が斜体 (イタリック) ではありません。
tomUndefined Italic プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 31 HRESULT SetItalic(INT Value)

文字を斜体 (イタリック) にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が斜体 (イタリック) です。
tomFalse 文字が斜体 (イタリック) ではありません。
tomToggle Italic プロパティの状態を切り替えます。
tomUndefined Italic プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 32 HRESULT GetKerning(FLOAT* pValue)

カーニングが行われる最小フォントサイズを取得します。

pValueFLOAT*outカーニングが行われる最小フォントサイズを、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

pValue が指す値が 0 の場合、カーニングはオフになります。正の値を指定すると、カーニング値以上のフォントポイントサイズに対してペアカーニングが有効になります。たとえば、値 1 は判読可能なすべてのサイズでカーニングを有効にし、16 はフォントサイズが 16 ポイント以上の場合にのみカーニングを有効にします。

vtbl 33 HRESULT SetKerning(FLOAT Value)

カーニングが行われる最小フォントサイズを設定します。

ValueFLOATinカーニングを行う最小サイズの新しい値を、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

この値が 0 の場合、カーニングはオフになります。正の値を指定すると、このカーニング値より大きいフォントサイズに対してペアカーニングが有効になります。たとえば、値 1 は判読可能なすべてのサイズでカーニングを有効にし、16 はフォントサイズが 16 ポイント以上の場合にのみカーニングを有効にします。

vtbl 34 HRESULT GetLanguageID(INT* pValue)

言語 ID または言語コード識別子 (LCID) を取得します。

pValueINT*out言語 ID または LCID です。下位ワードに言語識別子が含まれます。上位ワードは 0 であるか、LCID の上位ワードが含まれます。言語識別子を取得するには、上位ワードをマスクします。詳細については、Locale Identifiers を参照してください。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

"en-US" のような BCP-47 言語タグを取得するには、ITextRange2::GetText2(pBstr, tomLanguageTag) を呼び出します。pBstr には目的の言語タグを指定します。

vtbl 35 HRESULT SetLanguageID(INT Value)

言語 ID または言語コード識別子 (LCID) を設定します。

ValueINTin新しい言語識別子です。下位ワードに言語識別子が含まれます。上位ワードは 0 であるか、ロケール識別子 LCID の上位ワードが含まれます。詳細については、Locale Identifiers を参照してください。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

Value の上位ニブルが tomCharset の場合、下位バイトの charset から charrep を設定し、次のバイトからピッチとファミリを設定します。ITextFont2::SetCharRep も参照してください。

Value の上位ニブルが tomCharRepFromLcid の場合、LCID から charrep を設定し、LCID も設定します。詳細については ITextFont::GetLanguageID を参照してください。

"en-US" のような BCP-47 言語タグを設定するには、ITextRange2::SetText2 を呼び出し、tomLanguageTag と bstr に言語タグを設定します。

vtbl 36 HRESULT GetName(LPWSTR* pbstr)

フォント名を取得します。

pbstrLPWSTR*outフォント名です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
E_OUTOFMEMORY
 文字列用のメモリを割り当てられませんでした。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 37 HRESULT SetName(LPWSTR bstr)

フォント名を設定します。

bstrLPWSTRin新しいフォント名です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 名前が長すぎます。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 38 HRESULT GetOutline(INT* pValue)

文字が輪郭 (アウトライン) 文字として表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が輪郭 (アウトライン) 文字として表示されます。
tomFalse 文字が輪郭 (アウトライン) 文字として表示されません。
tomUndefined Outline プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_OUTLINE 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 39 HRESULT SetOutline(INT Value)

文字を輪郭 (アウトライン) 文字として表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が輪郭表示されています。
tomFalse 文字が輪郭表示されていません。
tomToggle Outline プロパティの状態を切り替えます。
tomUndefined Outline プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 40 HRESULT GetPosition(FLOAT* pValue)

文字がベースラインに対して垂直方向にオフセットされる量を取得します。

pValueFLOAT*out垂直方向のオフセット量を、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

表示されるテキストでは、通常このプロパティの値は 0 です。正の値はテキストを上げ、負の値は下げます。

vtbl 41 HRESULT SetPosition(FLOAT Value)

文字がベースラインに対して垂直方向にオフセットされる量を設定します。

ValueFLOATin 垂直方向のオフセット量の新しい値を、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

表示されるテキストでは、通常このプロパティの値は 0 です。正の値はテキストを上げ、負の値は下げます。

vtbl 42 HRESULT GetProtected(INT* pValue)

文字が変更の試みに対して保護されているかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が保護されています。
tomFalse 文字が保護されていません。
tomUndefined Protected プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

一般に、範囲の書式や内容を変更しようとする Text Object Model (TOM) のメソッドは、その範囲の一部が保護されている場合、またはドキュメントが読み取り専用の場合、E_ACCESSDENIED で失敗します。保護されたテキストを変更するには、TOM クライアントは変更対象のテキストの保護を解除しようと試みる必要があります。ドキュメントの所有者はこれを許可する場合があります。たとえばリッチエディットコントロールでは、保護されたテキストを変更しようとすると、ドキュメントの作成者に EN_PROTECTED 通知コードが送られ、作成者は変更を拒否または許可できます。作成者とは、CreateWindow 関数を通じてウィンドウ付きのリッチエディットコントロールを作成したクライアント、または CreateTextServices 関数を呼び出してウィンドウレスのリッチエディットコントロールを作成した ITextHost オブジェクトです。

vtbl 43 HRESULT SetProtected(INT Value)

文字を変更の試みに対して保護するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が保護されています。
tomFalse 文字が保護されていません。
tomToggle Protected プロパティの状態を切り替えます。
tomUndefined Protected プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

一般に、範囲の書式や内容を変更しようとする Text Object Model (TOM) のメソッドは、その範囲の一部が保護されている場合、またはドキュメントが読み取り専用の場合、E_ACCESSDENIED で失敗します。保護されたテキストを変更するには、TOM クライアントは変更対象のテキストの保護を解除しようと試みる必要があります。ドキュメントの所有者はこれを許可する場合があります。たとえばリッチエディットコントロールでは、保護されたテキストを変更しようとすると、ドキュメントの作成者に EN_PROTECTED 通知コードが送られ、作成者は変更を拒否または許可できます。作成者とは、CreateWindow 関数を通じてウィンドウ付きのリッチエディットコントロールを作成したクライアント、または CreateTextServices 関数を呼び出してウィンドウレスのリッチエディットコントロールを作成した ITextHost オブジェクトです。

vtbl 44 HRESULT GetShadow(INT* pValue)

文字が影付き文字として表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が影付き文字として表示されます。
tomFalse 文字が影付き文字として表示されません。
tomUndefined Shadow プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_SHADOW 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 45 HRESULT SetShadow(INT Value)

文字を影付き文字として表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が影付きです。
tomFalse 文字が影付きではありません。
tomToggle Shadow プロパティの状態を切り替えます。
tomUndefined Shadow プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 46 HRESULT GetSize(FLOAT* pValue)

フォントサイズを取得します。(ITextFont.GetSize)

pValueFLOAT*outフォントサイズを、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 47 HRESULT SetSize(FLOAT Value)

フォントサイズを設定します。

ValueFLOATin新しいフォントサイズを、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 48 HRESULT GetSmallCaps(INT* pValue)

文字が小型大文字 (スモールキャップ) かどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が小型大文字 (スモールキャップ) です。
tomFalse 文字が小型大文字 (スモールキャップ) ではありません。
tomUndefined SmallCaps プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_SMALLCAPS 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 49 HRESULT SetSmallCaps(INT Value)

文字を小型大文字 (スモールキャップ) にするかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が小型大文字 (スモールキャップ) です。
tomFalse 文字が小型大文字 (スモールキャップ) ではありません。
tomToggle SmallCaps プロパティの状態を切り替えます。
tomUndefined SmallCaps プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 50 HRESULT GetSpacing(FLOAT* pValue)

文字間の水平方向の間隔の量を取得します。

pValueFLOAT*out文字間の水平方向の間隔を、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

表示されるテキストでは、通常、文字間隔の値は 0 です。正の値は間隔を広げ、負の値は狭めます。

vtbl 51 HRESULT SetSpacing(FLOAT Value)

文字間の水平方向の間隔の量を設定します。

ValueFLOATin文字間の水平方向の間隔の新しい値を、浮動小数点のポイント単位で表したものです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。

解説(Remarks)

表示されるテキストでは、通常、文字間隔の値は 0 です。正の値は間隔を広げ、負の値は狭めます。

vtbl 52 HRESULT GetStrikeThrough(INT* pValue)

文字が中央に水平線を引いて表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が中央に水平線を引いて表示されます。
tomFalse 文字が中央に水平線を引いて表示されません。
tomUndefined StrikeThrough プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_STRIKEOUT 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 53 HRESULT SetStrikeThrough(INT Value)

文字を中央に水平線を引いて表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字の中央に水平線が引かれています。
tomFalse 文字の中央に水平線が引かれていません。
tomToggle StrikeThrough プロパティの状態を切り替えます。
tomUndefined StrikeThrough プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 54 HRESULT GetSubscript(INT* pValue)

文字が下付き文字として表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が下付き文字として表示されます。
tomFalse 文字が下付き文字として表示されません。
tomUndefined Subscript プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_SUBSCRIPT 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 55 HRESULT SetSubscript(INT Value)

文字を下付き文字として表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が下付き文字として表示されます。
tomFalse 文字が下付き文字として表示されません。
tomToggle Subscript プロパティの状態を切り替えます。
tomUndefined Subscript プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 56 HRESULT GetSuperscript(INT* pValue)

文字が上付き文字として表示されるかどうかを取得します。

pValueINT*out

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が上付き文字として表示されます。
tomFalse 文字が上付き文字として表示されません。
tomUndefined Superscript プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。

解説(Remarks)

このプロパティは CFE_SUPERSCRIPT 効果に対応します。この効果は CHARFORMAT2 構造体で説明されています。

vtbl 57 HRESULT SetSuperscript(INT Value)

文字を上付き文字として表示するかどうかを設定します。

ValueINTin

次のいずれかを指定できる tomBool 値です。

値 意味
tomTrue 文字が上付き文字として表示されます。
tomFalse 文字が上付き文字として表示されません。
tomToggle Superscript プロパティの状態を切り替えます。
tomUndefined Superscript プロパティが未定義です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 58 HRESULT GetUnderline(INT* pValue)

範囲内の文字の下線の種類を取得します。

pValueINT*out

下線の種類です。次の値のいずれかを指定できます。

tomNone

tomSingle

tomWords

tomDouble

tomDotted

tomDash

tomDashDot

tomDashDotDot

tomWave

tomThick

tomHair

tomDoubleWave

tomHeavyWave

tomLongDash

tomThickDash

tomThickDashDot

tomThickDashDotDot

tomThickDotted

tomThickLongDash

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 59 HRESULT SetUnderline(INT Value)

範囲内の文字の下線の種類を設定します。

ValueINTin

下線の種類です。次の値のいずれかを指定できます。

tomNone

tomSingle

tomWords

tomDouble

tomDotted

tomDash

tomDashDot

tomDashDotDot

tomWave

tomThick

tomHair

tomDoubleWave

tomHeavyWave

tomLongDash

tomThickDash

tomThickDashDot

tomThickDashDotDot

tomThickDotted

tomThickLongDash

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
vtbl 60 HRESULT GetWeight(INT* pValue)

範囲内の文字のフォントの太さを取得します。

pValueINT*out

フォントの太さです。Bold プロパティは Weight プロパティの 2 値版であり、太さを FW_BOLD に設定します。フォントの太さは LOGFONT 構造体および IFont インターフェイスに存在します。Windows では、フォントの太さについて次の段階が定義されています。

フォントの太さ 値
FW_DONTCARE 0
FW_THIN 100
FW_EXTRALIGHT 200
FW_LIGHT 300
FW_NORMAL 400
FW_MEDIUM 500
FW_SEMIBOLD 600
FW_BOLD 700
FW_EXTRABOLD 800
FW_HEAVY 900

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
vtbl 61 HRESULT SetWeight(INT Value)

範囲内の文字のフォントの太さを設定します。

ValueINTin

新しいフォントの太さです。Bold プロパティは Weight プロパティの 2 値版であり、太さを FW_BOLD に設定します。フォントの太さは LOGFONT 構造体および IFont インターフェイスに存在します。Windows では、フォントの太さについて次の段階が定義されています。

フォントの太さ 値
FW_DONTCARE 0
FW_THIN 100
FW_EXTRALIGHT 200
FW_LIGHT 300
FW_NORMAL 400
FW_MEDIUM 500
FW_SEMIBOLD 600
FW_BOLD 700
FW_EXTRABOLD 800
FW_HEAVY 900

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。失敗した場合は、次の COM エラーコードのいずれかを返します。 COM のエラーコードの詳細については、Error Handling in COM を参照してください。

リターンコード 説明
E_INVALIDARG
 無効な引数です。
CO_E_RELEASED
 フォントオブジェクトが、削除された範囲にアタッチされています。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_ITextFont "{8CC497C3-A1DF-11CE-8098-00AA0047BE5D}"
#usecom global ITextFont IID_ITextFont "{}"
#comfunc global ITextFont_GetDuplicate      7 sptr
#comfunc global ITextFont_SetDuplicate      8 sptr
#comfunc global ITextFont_CanChange         9 var
#comfunc global ITextFont_IsEqual           10 sptr,var
#comfunc global ITextFont_Reset             11 int
#comfunc global ITextFont_GetStyle          12 var
#comfunc global ITextFont_SetStyle          13 int
#comfunc global ITextFont_GetAllCaps        14 var
#comfunc global ITextFont_SetAllCaps        15 int
#comfunc global ITextFont_GetAnimation      16 var
#comfunc global ITextFont_SetAnimation      17 int
#comfunc global ITextFont_GetBackColor      18 var
#comfunc global ITextFont_SetBackColor      19 int
#comfunc global ITextFont_GetBold           20 var
#comfunc global ITextFont_SetBold           21 int
#comfunc global ITextFont_GetEmboss         22 var
#comfunc global ITextFont_SetEmboss         23 int
#comfunc global ITextFont_GetForeColor      24 var
#comfunc global ITextFont_SetForeColor      25 int
#comfunc global ITextFont_GetHidden         26 var
#comfunc global ITextFont_SetHidden         27 int
#comfunc global ITextFont_GetEngrave        28 var
#comfunc global ITextFont_SetEngrave        29 int
#comfunc global ITextFont_GetItalic         30 var
#comfunc global ITextFont_SetItalic         31 int
#comfunc global ITextFont_GetKerning        32 var
#comfunc global ITextFont_SetKerning        33 float
#comfunc global ITextFont_GetLanguageID     34 var
#comfunc global ITextFont_SetLanguageID     35 int
#comfunc global ITextFont_GetName           36 var
#comfunc global ITextFont_SetName           37 wstr
#comfunc global ITextFont_GetOutline        38 var
#comfunc global ITextFont_SetOutline        39 int
#comfunc global ITextFont_GetPosition       40 var
#comfunc global ITextFont_SetPosition       41 float
#comfunc global ITextFont_GetProtected      42 var
#comfunc global ITextFont_SetProtected      43 int
#comfunc global ITextFont_GetShadow         44 var
#comfunc global ITextFont_SetShadow         45 int
#comfunc global ITextFont_GetSize           46 var
#comfunc global ITextFont_SetSize           47 float
#comfunc global ITextFont_GetSmallCaps      48 var
#comfunc global ITextFont_SetSmallCaps      49 int
#comfunc global ITextFont_GetSpacing        50 var
#comfunc global ITextFont_SetSpacing        51 float
#comfunc global ITextFont_GetStrikeThrough  52 var
#comfunc global ITextFont_SetStrikeThrough  53 int
#comfunc global ITextFont_GetSubscript      54 var
#comfunc global ITextFont_SetSubscript      55 int
#comfunc global ITextFont_GetSuperscript    56 var
#comfunc global ITextFont_SetSuperscript    57 int
#comfunc global ITextFont_GetUnderline      58 var
#comfunc global ITextFont_SetUnderline      59 int
#comfunc global ITextFont_GetWeight         60 var
#comfunc global ITextFont_SetWeight         61 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。