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

ITextPara

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

公式ドキュメント

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

解説(Remarks)

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

Sub AttributeCopy(r1 As ITextRange, r2 As ITextRange)
    Dim tf As ITextFont
    tf = r1.Font                ' Value は既定のプロパティです    
    tf.Bold = tomTrue           ' 一部を変更できます
    tf.Size = 12
    tf.Animation = tomSparkleText
    r2.Font = tf                ' フォント属性を一度にすべて適用します
End Sub

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

ITextPara インターフェイスは、Word の段落ダイアログボックスをカプセル化します。すべての測定値は浮動小数点のポイント単位で指定されます。リッチエディットコントロールは、TOM 経由でも Rich Text Format (RTF) コンバーター経由でも、すべての ITextPara プロパティをそのまま(つまり変更せずに)受け取って返すことができます。ただし、次のプロパティはコントロールの表示には影響しません:

メソッド 48

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

vtbl 7 HRESULT GetDuplicate(ITextPara** ppPara)

指定した段落書式オブジェクトの複製を作成します。duplicate プロパティは、ITextPara オブジェクトの既定のプロパティです。

ppParaITextPara**out複製された ITextPara オブジェクト。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_OUTOFMEMORY
 新しいオブジェクト用のメモリを割り当てられませんでした。
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 8 HRESULT SetDuplicate(ITextPara* pPara)

指定した書式をコピーして、既存の段落の書式を設定します。

pParaITextPara*inoptional新しい段落書式を格納している ITextPara 範囲。

戻り値

型: HRESULT

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

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

解説(Remarks)

tomUndefined の値は効果がありません。つまり、対象の値を変更しません。

vtbl 9 HRESULT CanChange(INT* pValue)

段落書式を変更できるかどうかを判断します。

pValueINT*out段落書式を変更できる場合は tomTrue、変更できない場合は tomFalse になる変数。このパラメーターは null にできます。

戻り値

型: HRESULT

段落書式を変更できる場合、ITextPara::CanChange は成功して S_OK を返します。段落書式を変更できない場合、このメソッドは失敗して S_FALSE を返します。COM エラーコードの詳細については、COM のエラー処理 を参照してください。

解説(Remarks)

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

vtbl 10 HRESULT IsEqual(ITextPara* pPara, INT* pValue)

現在の範囲が、指定した範囲と同じプロパティを持つかどうかを判断します。

pParaITextPara*inoptional現在の範囲と比較される ITextPara 範囲。
pValueINT*out比較結果。この値は null にできます。

戻り値

型: HRESULT

オブジェクトが等しい場合、ITextPara::IsEqual は成功して S_OK を返します。オブジェクトが等しくない場合、このメソッドは失敗して S_FALSE を返します。COM エラーコードの詳細については、COM のエラー処理 を参照してください。

vtbl 11 HRESULT Reset(INT Value)

段落書式を、選択した既定値にリセットします。

ValueINTin

リセットの種類。次の値のいずれかを指定できます。

値 意味
tomDefault
 RTF の \pard(つまり段落の既定制御ワード)で定義される段落書式に使用します。
tomUndefined
 すべての未定義値に使用します。tomUndefined の値は、複製(クローン)された ITextPara オブジェクトに対してのみ有効です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 12 HRESULT GetStyle(INT* pValue)

指定した範囲内の段落のスタイルハンドルを取得します。

pValueINT*out段落のスタイルハンドル。詳細については「解説」を参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

Text Object Model (TOM) バージョン 1.0 には、ユーザー定義のスタイルハンドルの意味を指定する方法はありません。それらは、TOM を実装するテキストシステムの他の機能に依存します。負のスタイルハンドルは、組み込みの文字スタイルおよび段落スタイル用に予約されています。現在定義されている値を次の表に示します。以下のスタイルの説明については、Microsoft Word のドキュメントを参照してください。

スタイル 値 スタイル 値
StyleNormal –1 StyleTableofAuthorities –45
StyleHeading1 –2 StyleMacroText –46
StyleHeading2 –3 StyleTOAHeading –47
StyleHeading3 –4 StyleList –48
StyleHeading4 –5 StyleListBullet –49
StyleHeading5 –6 StyleListNumber –50
StyleHeading6 –7 StyleList2 –51
StyleHeading7 –8 StyleList3 –52
StyleHeading8 –9 StyleList4 –53
StyleHeading9 –10 StyleList5 –54
StyleIndex1 –11 StyleListBullet2 –55
StyleIndex2 –12 StyleListBullet3 –56
StyleIndex3 –13 StyleListBullet4 –57
StyleIndex4 –14 StyleListBullet5 –58
StyleIndex5 –15 StyleListNumber2 –59
StyleIndex6 –16 StyleListNumber3 –60
StyleIndex7 –17 StyleListNumber4 –61
StyleIndex8 –18 StyleListNumber5 –62
StyleIndex9 –19 StyleTitle –63
StyleTOC1 –20 StyleClosing –64
StyleTOC2 –21 StyleSignature –65
StyleTOC3 –22 StyleDefaultParagraphFont –66
StyleTOC4 –23 StyleBodyText –67
StyleTOC5 –24 StyleBodyTextIndent –68
StyleTOC6 –25 StyleListContinue –69
StyleTOC7 –26 StyleListContinue2 –70
StyleTOC8 –27 StyleListContinue3 –71
StyleTOC9 –28 StyleListContinue4 –72
StyleNormalIndent –29 StyleListContinue5 –73
StyleFootnoteText –30 StyleMessageHeader –74
StyleAnnotationText –31 StyleSubtitle –75
StyleHeader –32 StyleSalutation –76
StyleFooter –33 StyleDate –77
StyleIndexHeading –34 StyleBodyTextFirstIndent –78
StyleCaption –35 StyleBodyTextFirstIndent2 –79
StyleTableofFigures –36 StyleNoteHeading –80
StyleEnvelopeAddress –37 StyleBodyText2 –81
StyleEnvelopeReturn –38 StyleBodyText3 –82
StyleFootnoteReference –39 StyleBodyTextIndent2 –83
StyleAnnotationReference –40 StyleBodyTextIndent3 –84
StyleLineNumber –41 StyleBlockQuotation –85
StylePageNumber –42 StyleHyperlink –86
StyleEndnoteReference –43 StyleHyperlinkFollowed –87
StyleEndnoteText –44    
vtbl 13 HRESULT SetStyle(INT Value)

範囲内の段落に段落スタイルを設定します。

ValueINTin新しい段落スタイルハンドル。スタイルの一覧については、ITextPara::GetStyle の「解説」セクションを参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 14 HRESULT GetAlignment(INT* pValue)

現在の段落の配置値を取得します。

pValueINT*out

段落の配置。次の値のいずれかになります。

tomAlignLeft

tomAlignCenter

tomAlignRight

tomAlignJustify

tomAlignInterWord

tomAlignNewspaper

tomAlignInterLetter

tomAlignScaled

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 pValue パラメーターが null です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 15 HRESULT SetAlignment(INT Value)

段落の配置を設定します。

ValueINTin新しい段落の配置。指定可能な値の一覧については、ITextPara::GetAlignment メソッドを参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 16 HRESULT GetHyphenation(tomConstants* pValue)

範囲に対して自動ハイフネーションが有効かどうかを判断します。

pValuetomConstants*out

次の値のいずれかになる変数:

値 意味
tomTrue
 自動ハイフネーションが有効です。
tomFalse
 自動ハイフネーションが無効です。
tomUndefined
 ハイフネーションプロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

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

vtbl 17 HRESULT SetHyphenation(INT Value)

範囲内の段落のハイフネーションを制御します。

ValueINTin

ハイフネーションの制御方法を示します。次の値のいずれかを指定できます。

値 意味
tomTrue
 自動ハイフネーションが有効です。
tomFalse
 自動ハイフネーションが無効です。
tomUndefined
 ハイフネーションプロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 18 HRESULT GetFirstLineIndent(FLOAT* pValue)

左インデントを基準として、段落の最初の行をインデントする量を取得します。左インデントは、段落の最初の行を除くすべての行に適用されるインデントです。

pValueFLOAT*out最初の行のインデント量(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

最初の行のインデント量を設定するには、ITextPara::SetIndents メソッドを呼び出します。

その他すべての行のインデント(つまり左インデント)を取得および設定するには、ITextPara::GetLeftIndent と ITextPara::SetIndents を使用します。

vtbl 19 HRESULT GetKeepTogether(tomConstants* pValue)

段落内で改ページが許可されるかどうかを判断します。

pValuetomConstants*out

次の値のいずれかになる変数。

値 意味
tomTrue
 段落内での改ページは許可されません。
tomFalse
 段落内での改ページが許可されます。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

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

vtbl 20 HRESULT SetKeepTogether(INT Value)

範囲内の段落内で改ページを許可するかどうかを制御します。

ValueINTin

範囲内の段落内で改ページを許可するかどうかを示します。次の値のいずれかを指定できます。

値 意味
tomTrue
 段落内での改ページは許可されません。
tomFalse
 段落内での改ページが許可されます。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

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

解説(Remarks)

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

vtbl 21 HRESULT GetKeepWithNext(tomConstants* pValue)

範囲内の段落間で改ページが許可されるかどうかを判断します。

pValuetomConstants*out

次の値のいずれかになる変数:

値 意味
tomTrue
 段落間での改ページは許可されません。
tomFalse
 段落間での改ページが許可されます。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

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

vtbl 22 HRESULT SetKeepWithNext(INT Value)

範囲内の段落間で改ページを許可するかどうかを制御します。

ValueINTin

範囲内の段落間で改ページを使用できるかどうかを示します。次の値のいずれかを指定できます。

値 意味
tomTrue
 段落間での改ページは許可されません。
tomFalse
 段落間での改ページが許可されます。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

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

解説(Remarks)

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

vtbl 23 HRESULT GetLeftIndent(FLOAT* pValue)

段落の最初の行を除くすべての行をインデントする距離を取得します。この距離は左余白を基準とします。

pValueFLOAT*out左インデント(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

左インデント量を設定するには、ITextPara::SetIndents メソッドを呼び出します。

最初の行のインデントを取得するには、ITextPara::GetFirstLineIndent を呼び出します。

vtbl 24 HRESULT GetLineSpacing(FLOAT* pValue)

テキスト範囲の行間値を取得します。

pValueFLOAT*out

行間値。次の表は、行間ルールごとにこの値がどのように解釈されるかを示します。

行間ルール 意味
tomLineSpaceSingle 行間値は無視されます。
tomLineSpace1pt5 行間値は無視されます。
tomLineSpaceDouble 行間値は無視されます。
tomLineSpaceAtLeast 行間値は、ある行から次の行までの間隔を浮動小数点のポイント単位で指定します。ただし、値が 1 行分より小さい場合、コントロールは 1 行間隔でテキストを表示します。
tomLineSpaceExactly 行間値は、ある行から次の行までの正確な間隔を浮動小数点のポイント単位で指定します(値が 1 行分より小さい場合でも同様です)。
tomLineSpaceMultiple 行間値は、行間を行数単位で指定します。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

行間ルールを取得するには、ITextPara::GetLineSpacingRule メソッドを呼び出します。

vtbl 25 HRESULT GetLineSpacingRule(INT* pValue)

テキスト範囲の行間ルールを取得します。

pValueINT*out

行間ルールを示す、次の値のいずれかになる変数。

tomLineSpaceSingle

tomLineSpace1pt5

tomLineSpaceDouble

tomLineSpaceAtLeast

tomLineSpaceExactly

tomLineSpaceMultiple

tomLineSpacePercent

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 26 HRESULT GetListAlignment(INT* pValue)

箇条書きリストおよび番号付きリストで使用する配置の種類を取得します。

pValueINT*out

箇条書きおよび番号付けの配置の種類を示す、次の値のいずれかになる変数。

値 意味
tomAlignLeft テキストは左揃えになります。
tomAlignCenter テキストは行内で中央揃えになります。
tomAlignRight テキストは右揃えになります。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

さまざまなリストの種類の説明については、ITextPara::GetListType メソッドを参照してください。

vtbl 27 HRESULT SetListAlignment(INT Value)

段落で使用する箇条書きまたは番号付きテキストの配置を設定します。

ValueINTin新しいリストの配置値。指定可能な値については、ITextPara::GetListAlignment を参照してください。

戻り値

型: HRESULT

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

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

段落で使用されるリストレベルインデックスを取得します。

pValueINT*out

リストレベルインデックスとなる変数。pValue の値は次のいずれかになります。

値 意味
0 リストなし。
1 第 1 レベル(最も外側)のリスト。
2 第 2 レベル(入れ子)のリスト。これはレベル 1 のリスト項目の下に入れ子になります。
3 第 3 レベル(入れ子)のリスト。これはレベル 2 のリスト項目の下に入れ子になります。
以降も同様 入れ子は同様に続きます。
 

HTML ドキュメントでは、通常は最大 3 レベルまでです。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 29 HRESULT SetListLevelIndex(INT Value)

段落で使用するリストレベルインデックスを設定します。

ValueINTin新しいリストレベルインデックス値。指定可能な値については、ITextPara::GetListLevelIndex を参照してください。

戻り値

型: HRESULT

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

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

解説(Remarks)

リストレベルインデックスを設定しても、リストのインデントやその他の段落プロパティは自動的には変更されません。

vtbl 30 HRESULT GetListStart(INT* pValue)

リストの番号付けシーケンスの開始値またはコードを取得します。

pValueINT*outリストの番号付けシーケンスの開始値またはコード。指定可能な値については、ITextPara::GetListType メソッドを参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

どのシーケンスを使用するかについては、ITextPara::GetListType メソッドを参照してください。

vtbl 31 HRESULT SetListStart(INT Value)

番号付きリストの開始番号または Unicode 値を設定します。

ValueINTin番号付きリストの新しい開始番号または Unicode 値。

戻り値

型: HRESULT

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

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

解説(Remarks)

リストのその他の特性は、ITextPara::SetListType で指定します。

vtbl 32 HRESULT GetListTab(FLOAT* pValue)

リストタブの設定を取得します。これは、最初の行のインデントと最初の行のテキストとの間の距離です。番号付きまたは箇条書きのテキストは、最初の行のインデント値の位置で左揃え、中央揃え、または右揃えになります。

pValueFLOAT*outリストタブの設定。リストタブ値は浮動小数点のポイント単位です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

番号付きまたは箇条書きのテキストが左揃え、中央揃え、右揃えのいずれであるかを判断するには、ITextPara::GetListAlignment を呼び出します。

vtbl 33 HRESULT SetListTab(FLOAT Value)

リストタブの設定を行います。これは、最初のインデントと最初の行のテキストの先頭との間の距離です。

ValueFLOATin新しいリストタブ値(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 34 HRESULT GetListType(INT* pValue)

段落で使用する番号付けの種類を取得します。

pValueINT*out

リストの番号付けの種類を示す、次の値のいずれかになる変数。

tomListNone

tomListBullet

tomListNumberAsArabic

tomListNumberAsLCLetter

tomListNumberAsUCLetter

tomListNumberAsLCRoman

tomListNumberAsUCRoman

tomListNumberAsSequence

tomListNumberedCircle

tomListNumberedBlackCircleWingding

tomListNumberedWhiteCircleWingding

tomListNumberedArabicWide

tomListNumberedChS

tomListNumberedChT

tomListNumberedJpnChs

tomListNumberedJpnKor

tomListNumberedArabic1

tomListNumberedArabic2

tomListNumberedHebrew

tomListNumberedThaiAlpha

tomListNumberedThaiNum

tomListNumberedHindiAlpha

tomListNumberedHindiAlpha1

tomListNumberedHindiNum

既定では、番号の後に右かっこが付きます(例: 1))。ただし、pValue には、異なる書式を示す次のフラグのいずれかを含めることができます。

tomListMinus

tomListParentheses

tomListPeriod

tomListPlain

戻り値

型: HRESULT

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

リターンコード 説明
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

32 を超える値は、箇条書き記号の Unicode 値に対応します。

モバイル版 Microsoft Office のリッチエディットコントロールは、スタイルの設定を抑制するために tomIgnoreNumberStyle を使用します。

次の Microsoft Visual Basic for Applications (VBA) の例では、番号 2 から始めて番号の後にピリオドを付けて、範囲内の段落に番号を付けます。

    range.Para.ListStart = 2
    range.Para.ListType = tomListNumberAsArabic + tomListPeriod

tomListNumberAsSequence の例として、ListStart に 0x2780 を設定すると、丸で囲まれた数字が得られます。Unicode Standard には、さらに多くの番号付けシーケンスの例があります。

vtbl 35 HRESULT SetListType(INT Value)

段落で使用するリストの種類を設定します。

ValueINTin新しいリストの種類。指定可能なリストの種類については、ITextPara::GetListType メソッドを参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 36 HRESULT GetNoLineNumber(INT* pValue)

段落の番号付けが有効かどうかを判断します。

pValueINT*out

次の値のいずれかになる変数:

値 意味
tomTrue 行番号付けが無効です。
tomFalse 行番号付けが有効です。
tomUndefined プロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

段落の番号付けとは、範囲内の段落に番号が付けられることです。番号は段落の最初の行に表示されます。

vtbl 37 HRESULT SetNoLineNumber(INT Value)

範囲内の段落の行番号付けを抑制するかどうかを判断します。

ValueINTin

行番号付けを抑制するかどうかを示します。次の値のいずれかを指定できます。

値 意味
tomTrue
 行番号付けが無効です。
tomFalse
 行番号付けが有効です。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

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

解説(Remarks)

このプロパティは、範囲内の段落の番号付けに関係します。 Value が tomFalse の場合、段落の番号がその段落の最初の行に表示されます。

vtbl 38 HRESULT GetPageBreakBefore(INT* pValue)

範囲内の各段落が新しいページから始まる必要があるかどうかを判断します。

pValueINT*out

次の値のいずれかになる変数:

値 意味
tomTrue この範囲内の各段落は、新しいページから始まる必要があります。
tomFalse この範囲内の段落は、新しいページから始まる必要はありません。
tomUndefined プロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 39 HRESULT SetPageBreakBefore(INT Value)

範囲内の各段落の前に改ページを入れるかどうかを制御します。

ValueINTin

段落の前の改ページを制御する tomBool 値。次の値のいずれかになります。

値 意味
tomTrue
 この範囲内の段落は、新しいページから始まる必要があります。
tomFalse
 この範囲内の段落は、新しいページから始まる必要はありません。
tomToggle
 プロパティ値を切り替えます。
tomUndefined
 プロパティが未定義です。

戻り値

型: HRESULT

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

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

解説(Remarks)

このメソッドは Microsoft Word との互換性のために用意されています。リッチエディットコントロールによるテキストの表示方法には影響しません。

vtbl 40 HRESULT GetRightIndent(FLOAT* pValue)

段落の右余白インデントのサイズを取得します。

pValueFLOAT*out右インデント(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 41 HRESULT SetRightIndent(FLOAT Value)

段落の右余白を設定します。

ValueFLOATin右インデント(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 42 HRESULT SetIndents(FLOAT First, FLOAT Left, FLOAT Right)

段落の最初の行のインデント、左インデント、右インデントを設定します。

FirstFLOATin段落の最初の行のインデント(左インデントを基準とする)。値は浮動小数点のポイント単位で、正または負の値を指定できます。
LeftFLOATin段落の最初の行を除くすべての行の左インデント(左余白を基準とする)。値は浮動小数点のポイント単位で、正または負の値を指定できます。
RightFLOATin段落内のすべての行の右インデント(右余白を基準とする)。値は浮動小数点のポイント単位で、正または負の値を指定できます。この値は省略可能です。

戻り値

型: HRESULT

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

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

解説(Remarks)

行インデントで余白内にテキストを配置することはできません。左インデントが 0 のときに最初の行のインデントを負の値(ぶら下げ段落用)に設定すると、最初の行のインデントは 0 にリセットされます。プロパティの設定を保持しつつこの問題を回避するには、明示的に、または ITextPara::Reset メソッドを呼び出して、最初の行のインデント値を 0 に設定します。次に、ITextPara::SetIndents を呼び出して、負でない左インデント値を設定し、目的の最初の行のインデントを設定します。

vtbl 43 HRESULT SetLineSpacing(INT Rule, FLOAT Spacing)

段落の行間ルールと行間を設定します。

RuleINTin新しい行間ルールの値。指定可能なルール値の一覧と詳細については、ITextPara::GetLineSpacingRule メソッドを参照してください。
SpacingFLOATin新しい行間の値。行間ルールが Spacing 値を線形の寸法として扱う場合、Spacing は浮動小数点のポイント単位で指定します。

戻り値

型: HRESULT

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

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

解説(Remarks)

行間ルールと行間は連動して機能するため、最初のインデントと左インデントを一緒に設定する必要があるのと同様に、両者を一緒に設定する必要があります。

vtbl 44 HRESULT GetSpaceAfter(FLOAT* pValue)

段落の下の垂直方向の空白の量を取得します。

pValueFLOAT*out後方の空白値(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 45 HRESULT SetSpaceAfter(FLOAT Value)

段落の後に続く空白の量を設定します。

ValueFLOATin新しい後方の空白値(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

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

段落の上の垂直方向の空白の量を取得します。

pValueFLOAT*out前方の空白値(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 47 HRESULT SetSpaceBefore(FLOAT Value)

段落の前の空白の量を設定します。

ValueFLOATin新しい前方の空白値(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

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

範囲内の段落のウィドウ/オーファン制御の状態を取得します。

pValueINT*out

ウィドウ/オーファン制御の状態を示す tomBool 値。次の値のいずれかになります。

値 意味
tomTrue ウィドウまたはオーファンの印刷を防ぎます
tomFalse ウィドウまたはオーファンの印刷を許可します。
tomUndefined ウィドウ制御プロパティが未定義です。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

ウィドウは、段落の最後の行がページの先頭に単独で印刷されるときに発生します。オーファンは、段落の最初の行がページの末尾に単独で印刷される状態です。

vtbl 49 HRESULT SetWidowControl(INT Value)

ウィドウとオーファンの抑制を制御します。

ValueINTin

ウィドウとオーファンの抑制を制御する tomBool 値。次の値のいずれかを指定できます。

値 意味
tomTrue
 ウィドウとオーファンの印刷を防ぎます。
tomFalse
 ウィドウとオーファンの印刷を許可します。
tomToggle
 値が切り替えられます。
tomUndefined
 変更なし。

戻り値

型: HRESULT

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

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

解説(Remarks)

このメソッドは Microsoft Word との互換性のために用意されています。リッチエディットコントロールによるテキストの表示方法には影響しません。

ウィドウは、段落の最後の行がページの先頭に単独で印刷されるときに発生します。オーファンは、段落の最初の行がページの末尾に単独で印刷される状態です。

vtbl 50 HRESULT GetTabCount(INT* pCount)

タブ数を取得します。

pCountINT*outタブ数。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

新しいインスタンスのタブ数は、基になるテキストエンジンによっては 0 以外になることがあります。たとえば、Microsoft Word のストーリーは明示的なタブが定義されていない状態で始まりますが、リッチエディットのインスタンスは 1 つの明示的なタブで始まります。明示的なタブがないことを確実にするには(つまりタブ数を 0 に設定するには)、ITextPara::ClearAllTabs を呼び出します。

vtbl 51 HRESULT AddTab(FLOAT tbPos, INT tbAlign, INT tbLeader)

変位 tbPos の位置に、種類 tbAlign、リーダースタイル tbLeader のタブを追加します。

tbPosFLOATin新しいタブの変位(浮動小数点のポイント単位)。
tbAlignINTin

タブ位置の配置オプション。次のいずれかを指定できます。

値 意味
tomAlignLeft
 テキストはタブ位置から左揃えになります。これが既定値です。
tomAlignCenter
 テキストはタブ位置を中心に中央揃えになります。
tomAlignRight
 テキストはタブ位置から右揃えになります。
tomAlignDecimal
 小数点がタブ位置に設定されます。これは、小数の列を揃えるのに便利です。
tomAlignBar
 タブ位置に縦棒が配置されます。テキストには影響しません。近くの行の同じ位置にある配置バーは、連続した縦線を形成します。
tbLeaderINTin

リーダー文字のスタイル。リーダー文字とは、タブ文字が占めるスペースを埋めるために使用される文字です。次のいずれかを指定できます。

値 意味
tomSpaces
 スペースが使用されます。これが既定値です。
tomDots
 ドットが使用されます。
tomDashes
 破線が使用されます。
tomLines
 実線が使用されます。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。

解説(Remarks)

位置 0 にタブが存在することはないと想定されています。複数の段落が対象となる場合、タブの共通部分が、タブ種類の上位ワードに 0x8000 を設定して返されます。

vtbl 52 HRESULT ClearAllTabs()

すべてのタブをクリアし、既定のタブ間隔で等間隔に配置されたタブに戻します。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 53 HRESULT DeleteTab(FLOAT tbPos)

指定した変位の位置にあるタブを削除します。

tbPosFLOATinタブを削除する変位(浮動小数点のポイント単位)。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_ACCESSDENIED
 書き込みアクセスが拒否されています。
E_INVALIDARG
 tbPos の値が 0 以下です。
E_OUTOFMEMORY
 メモリが不足しています。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
vtbl 54 HRESULT GetTab(INT iTab, FLOAT* ptbPos, INT* ptbAlign, INT* ptbLeader)

指定したタブのタブパラメーター(変位、配置、リーダースタイル)を取得します。

iTabINTin

情報を取得するタブのインデックス。数値インデックスまたは特殊な値(次の表を参照)を指定できます。タブインデックスは 0 から始まるため、iTab = 0 は最初に定義されたタブ、iTab = 1 は 2 番目に定義されたタブ、というように取得します。次の表は、iTab に指定できるすべての値をまとめたものです。

iTab 値 意味
tomTabBack –3 * ptbPos の前のタブを取得します
tomTabNext –2 * ptbPos の後のタブを取得します
tomTabHere –1 * ptbPos の位置のタブを取得します
>= 0 iTab のインデックスのタブを取得します(ptbPos は無視されます)。
ptbPosFLOAT*outタブの変位(浮動小数点のポイント単位)。タブが存在しない場合、* ptbPos の値は 0 になり、関連付けられた範囲に複数の値がある場合、* ptbPos の値は tomUndefined になります。
ptbAlignINT*outタブの配置。詳細については、ITextPara::AddTab を参照してください。
ptbLeaderINT*outタブのリーダー文字のスタイル。詳細については、ITextPara::AddTab を参照してください。

戻り値

型: HRESULT

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

リターンコード 説明
値
 意味
E_INVALIDARG
 引数が無効です。
CO_E_RELEASED
 この段落書式オブジェクトは、削除された範囲にアタッチされています。
S_FALSE
 iTab に対応するタブがありません。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITextPara "{8CC497C4-A1DF-11CE-8098-00AA0047BE5D}"
#usecom global ITextPara IID_ITextPara "{}"
#comfunc global ITextPara_GetDuplicate        7 sptr
#comfunc global ITextPara_SetDuplicate        8 sptr
#comfunc global ITextPara_CanChange           9 var
#comfunc global ITextPara_IsEqual             10 sptr,var
#comfunc global ITextPara_Reset               11 int
#comfunc global ITextPara_GetStyle            12 var
#comfunc global ITextPara_SetStyle            13 int
#comfunc global ITextPara_GetAlignment        14 var
#comfunc global ITextPara_SetAlignment        15 int
#comfunc global ITextPara_GetHyphenation      16 var
#comfunc global ITextPara_SetHyphenation      17 int
#comfunc global ITextPara_GetFirstLineIndent  18 var
#comfunc global ITextPara_GetKeepTogether     19 var
#comfunc global ITextPara_SetKeepTogether     20 int
#comfunc global ITextPara_GetKeepWithNext     21 var
#comfunc global ITextPara_SetKeepWithNext     22 int
#comfunc global ITextPara_GetLeftIndent       23 var
#comfunc global ITextPara_GetLineSpacing      24 var
#comfunc global ITextPara_GetLineSpacingRule  25 var
#comfunc global ITextPara_GetListAlignment    26 var
#comfunc global ITextPara_SetListAlignment    27 int
#comfunc global ITextPara_GetListLevelIndex   28 var
#comfunc global ITextPara_SetListLevelIndex   29 int
#comfunc global ITextPara_GetListStart        30 var
#comfunc global ITextPara_SetListStart        31 int
#comfunc global ITextPara_GetListTab          32 var
#comfunc global ITextPara_SetListTab          33 float
#comfunc global ITextPara_GetListType         34 var
#comfunc global ITextPara_SetListType         35 int
#comfunc global ITextPara_GetNoLineNumber     36 var
#comfunc global ITextPara_SetNoLineNumber     37 int
#comfunc global ITextPara_GetPageBreakBefore  38 var
#comfunc global ITextPara_SetPageBreakBefore  39 int
#comfunc global ITextPara_GetRightIndent      40 var
#comfunc global ITextPara_SetRightIndent      41 float
#comfunc global ITextPara_SetIndents          42 float,float,float
#comfunc global ITextPara_SetLineSpacing      43 int,float
#comfunc global ITextPara_GetSpaceAfter       44 var
#comfunc global ITextPara_SetSpaceAfter       45 float
#comfunc global ITextPara_GetSpaceBefore      46 var
#comfunc global ITextPara_SetSpaceBefore      47 float
#comfunc global ITextPara_GetWidowControl     48 var
#comfunc global ITextPara_SetWidowControl     49 int
#comfunc global ITextPara_GetTabCount         50 var
#comfunc global ITextPara_AddTab              51 float,int,int
#comfunc global ITextPara_ClearAllTabs        52
#comfunc global ITextPara_DeleteTab           53 float
#comfunc global ITextPara_GetTab              54 int,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。