ITextPara::SetKeepTogether メソッド (tom.h)

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

構文

HRESULT SetKeepTogether(
  [in] long Value
);

パラメーター

[in] Value

型: long

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

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

戻り値

型: HRESULT

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

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

注釈

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

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム	Windows
ヘッダー	tom.h
[DLL]	Msftedit.dll

関連項目

概念

ITextPara

PARAFORMAT2

リファレンス

Text オブジェクト モデル