ITextPara::GetKeepTogether メソッド (tom.h)
段落内で改ページを許可するかどうかを指定します。
構文
HRESULT GetKeepTogether(
long *pValue
);
パラメーター
pValue
型: long*
次のいずれかの値である変数。
| 値 | 意味 |
|---|---|
|
改ページは、段落内では許可されません。 |
|
改ページは、段落内で許可されます。 |
|
プロパティは未定義です。 |
戻り値
型: HRESULT
ITextPara::GetKeepTogether が成功すると、S_OKが返されます。 メソッドが失敗した場合は、次のいずれかの COM エラー コードを返します。 COM エラー コードの詳細については、「COM でのエラー処理」を参照してください。
| リターン コード | 説明 |
|---|---|
|
意味 |
|
引数が無効です。 |
|
段落書式オブジェクトは、削除された範囲にアタッチされます。 |
注釈
このプロパティは、PARAFORMAT2構造体で説明されている PFE_KEEP 効果に対応します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | tom.h |
| [DLL] | Msftedit.dll |
関連項目
概念
リファレンス