ITextPara2
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
Text Object Model (TOM) のリッチテキスト範囲の属性は、ITextFont と ITextPara という一対のデュアルインターフェイスを通じてアクセスします。(ITextPara2)
メソッド 16
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
罫線コレクションを取得します。
| ppBorders | IUnknown** | out | 罫線コレクション。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
このテキスト段落書式オブジェクトの複製を取得します。
| ppPara | ITextPara2** | out | 複製されたテキスト段落書式オブジェクト。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
別のテキスト段落オブジェクトのプロパティをコピーして、このオブジェクトのプロパティを設定します。
| pPara | ITextPara2* | inoptional | コピー元となるテキスト段落オブジェクト。 |
戻り値
Type: HRESULT
ITextPara2::SetDuplicate2 が成功した場合は S_OK を返します。メソッドが失敗した場合は、次のいずれかの COM エラーコードを返します。COM エラーコードの詳細については、「Error Handling in COM」を参照してください。
| 戻り値 | 説明 |
|---|---|
| 無効な引数です。 | |
| 書き込みアクセスが拒否されました。 | |
| メモリが不足しています。 |
解説(Remarks)
tomUndefined 値は効果がありません。
段落のフォント配置状態を取得します。
| pValue | INT* | out | 段落のフォント配置状態。次のいずれかの値を指定できます。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
中国語、日本語、韓国語テキストの段落のフォント配置を設定します。
| Value | INT | in | 段落のフォント配置。次のいずれかの値を指定できます。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
段落を両端揃えにしたときに、句読点記号を右マージンにぶら下げるかどうかを取得します。
| pValue | INT* | out | 次のいずれかの値を取り得る tomBool 値。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
段落を両端揃えにしたときに、句読点記号を右マージンにぶら下げるかどうかを設定します。
| Value | INT | in | 次のいずれかの値を取り得る tomBool 値。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
ドキュメント全体に対して定義できる垂直グリッドに段落の行をスナップするかどうかを取得します。
| pValue | INT* | out | 次のいずれかの値を取り得る tomBool 値。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
ドキュメント全体に対して定義できる垂直グリッドに段落の行をスナップするかどうかを設定します。
| Value | INT | in | 次のいずれかの値を取り得る tomBool 値。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
行頭にある句読点記号の前方の空白を詰めるかどうかを取得します。
| pValue | INT* | out | 次のいずれかの値を取り得る tomBool 値。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
行頭にある句読点記号の前方の空白を詰めるかどうかを設定します。
| Value | INT | in | 句読点記号の前方の空白を詰めるかどうかを示す tomBool。次のいずれかの値を指定できます。
|
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
段落書式の効果を取得します。
| pValue | INT* | out | 段落の効果。この値は、次のフラグの組み合わせを指定できます。 tomParaEffectRTLtomParaEffectKeeptomParaEffectKeepNexttomParaEffectPageBreakBeforetomParaEffectNoLineNumbertomParaEffectNoWidowControltomParaEffectDoNotHyphentomParaEffectSideBySidetomParaEffectCollapsedtomParaEffectOutlineLeveltomParaEffectBoxtomParaEffectTableRowDelimitertomParaEffectTable |
| pMask | INT* | out | 範囲全体でのフラグの差異。値が 1 の場合、対応する効果が範囲全体で同じであることを示します。挿入ポイントの場合、定義済みのすべての効果について値は 1 になります。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
tomTable フラグが設定されている場合は、ITextRange2::GetTable メソッドを使用して、さらに多くのテーブルプロパティを取得できます。
指定したプロパティの値を取得します。(ITextPara2.GetProperty)
| Type | INT | in | 取得するプロパティ値の ID。 |
| pValue | INT* | out | プロパティ値。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
tomParaPropMathAlign プロパティは、テキスト段落内の数式段落の数式配置を設定します。次のいずれかの値を指定できます。
このテキスト段落オブジェクトが、指定したテキスト段落オブジェクトと同じプロパティを持つかどうかを判定します。
| pPara | ITextPara2* | inoptional | 比較対象のテキスト段落オブジェクト。 |
| pB | INT* | out | テキスト段落オブジェクトが同じプロパティを持つ場合は tomTrue、そうでない場合は tomFalse となる tomBool 値。このパラメーターには NULL を指定できます。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
段落書式の効果を設定します。
| Value | INT | in | 段落の効果値。 この値は、ITextPara2::GetEffects の表で定義されているフラグの組み合わせを指定できます。 |
| Mask | INT | in | 目的のマスク。 この値は、ITextPara2::GetEffects の表で定義されているフラグの組み合わせを指定できます。 対応するマスクフラグが設定されている効果のみが変更されます。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
プロパティ値を設定します。
| Type | INT | in | 設定するプロパティ値のプロパティ ID。定義済みプロパティの一覧については、ITextPara2::GetProperty を参照してください。 |
| Value | INT | in | 設定するプロパティ値。 |
戻り値
Type: HRESULT
メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ITextPara2 "{C241F5E4-7206-11D8-A2C7-00A0D1D6C6B3}" #usecom global ITextPara2 IID_ITextPara2 "{}" #comfunc global ITextPara2_GetBorders 55 sptr #comfunc global ITextPara2_GetDuplicate2 56 sptr #comfunc global ITextPara2_SetDuplicate2 57 sptr #comfunc global ITextPara2_GetFontAlignment 58 var #comfunc global ITextPara2_SetFontAlignment 59 int #comfunc global ITextPara2_GetHangingPunctuation 60 var #comfunc global ITextPara2_SetHangingPunctuation 61 int #comfunc global ITextPara2_GetSnapToGrid 62 var #comfunc global ITextPara2_SetSnapToGrid 63 int #comfunc global ITextPara2_GetTrimPunctuationAtStart 64 var #comfunc global ITextPara2_SetTrimPunctuationAtStart 65 int #comfunc global ITextPara2_GetEffects 66 var,var #comfunc global ITextPara2_GetProperty 67 int,var #comfunc global ITextPara2_IsEqual2 68 sptr,var #comfunc global ITextPara2_SetEffects 69 int,int #comfunc global ITextPara2_SetProperty 70 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITextPara2 "{C241F5E4-7206-11D8-A2C7-00A0D1D6C6B3}" #usecom global ITextPara2 IID_ITextPara2 "{}" #comfunc global ITextPara2_GetBorders 55 sptr #comfunc global ITextPara2_GetDuplicate2 56 sptr #comfunc global ITextPara2_SetDuplicate2 57 sptr #comfunc global ITextPara2_GetFontAlignment 58 sptr #comfunc global ITextPara2_SetFontAlignment 59 int #comfunc global ITextPara2_GetHangingPunctuation 60 sptr #comfunc global ITextPara2_SetHangingPunctuation 61 int #comfunc global ITextPara2_GetSnapToGrid 62 sptr #comfunc global ITextPara2_SetSnapToGrid 63 int #comfunc global ITextPara2_GetTrimPunctuationAtStart 64 sptr #comfunc global ITextPara2_SetTrimPunctuationAtStart 65 int #comfunc global ITextPara2_GetEffects 66 sptr,sptr #comfunc global ITextPara2_GetProperty 67 int,sptr #comfunc global ITextPara2_IsEqual2 68 sptr,sptr #comfunc global ITextPara2_SetEffects 69 int,int #comfunc global ITextPara2_SetProperty 70 int,int ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。