CMFCRibbonEdit クラス
リボン バーにある編集コントロールを実装します。
構文
class CMFCRibbonEdit : public CMFCRibbonButton
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
| CMFCRibbonEdit::CMFCRibbonEdit | CMFCRibbonEdit オブジェクトを構築します。 |
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonEdit::CanBeStretched | CMFCRibbonEdit コントロールの高さをリボン行の高さに垂直方向に増加できるかどうかを示します。 |
| CMFCRibbonEdit::CMFCRibbonEdit | CMFCRibbonEdit オブジェクトを構築します。 |
| CMFCRibbonEdit::CopyFrom | 指定した CMFCRibbonEdit オブジェクトの状態を現在の CMFCRibbonEdit オブジェクトにコピーします。 |
| CMFCRibbonEdit::CreateEdit | CMFCRibbonEdit オブジェクトの新しいテキスト ボックスを作成します。 |
| CMFCRibbonEdit::D estroyCtrl | CMFCRibbonEdit オブジェクトを破棄します。 |
| CMFCRibbonEdit::D ropDownList | リスト ボックスをドロップダウンします。 |
| CMFCRibbonEdit::EnableSpinButtons | テキスト ボックスのスピン ボタンの範囲を有効にして設定します。 |
| CMFCRibbonEdit::GetCompactSize | CFMCRibbonEdit オブジェクトのコンパクト サイズを取得します。 |
| CMFCRibbonEdit::GetEditText | テキスト ボックス内のテキストを取得します。 |
| CMFCRibbonEdit::GetIntermediateSize | CMFCRibbonEdit オブジェクトの中間サイズを取得します。 |
| CMFCRibbonEdit::GetTextAlign | テキスト ボックス内のテキストの配置を取得します。 |
| CMFCRibbonEdit::GetWidth | CMFCRibbonEdit コントロールの幅をピクセル単位で取得します。 |
| CMFCRibbonEdit::HasCompactMode | CMFCRibbonEdit コントロールの表示サイズをコンパクトにできるかどうかを示します。 |
| CMFCRibbonEdit::HasFocus | CMFCRIbbonEdit コントロールにフォーカスがあるかどうかを示します。 |
| CMFCRibbonEdit::HasLargeMode | CMFCRibbonEdit コントロールの表示サイズを大きくできるかどうかを示します。 |
| CMFCRibbonEdit::HasSpinButtons | テキスト ボックスにスピン ボタンがあるかどうかを示します。 |
| CMFCRibbonEdit::IsHighlighted | CMFCRibbonEdit コントロールが強調表示されているかどうかを示します。 |
| CMFCRibbonEdit::OnAfterChangeRect | CMFCRibbonEdit コントロールの表示四角形の寸法が変更されたときにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnDraw | CMFCRibbonEdit コントロールを描画するためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnDrawLabelAndImage | CMFCRibbonEdit コントロールのラベルとイメージを描画するためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnDrawOnList | コマンド リスト ボックスに CMFCRibbonEdit コントロールを描画するためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnEnable | CMFCRibbonEdit コントロールを有効または無効にするためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnHighlight | ポインターが CMFCRibbonEdit コントロールの境界を出入りするときにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnKey | ユーザーがキーヒントを押し、 CMFCRibbonEdit コントロールにフォーカスがあるときに、フレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnLButtonDown | ユーザーがコントロールのマウスの左ボタンを押したときに、 CMFCRibbonEdit コントロールを更新するためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnLButtonUp | ユーザーがマウスの左ボタンを離したときにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnRTLChanged | レイアウトの方向が変わると、 CMFCRibbonEdit コントロールを更新するためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::OnShow | CMFCRibbonEdit コントロールを表示または非表示にするためにフレームワークによって呼び出されます。 |
| CMFCRibbonEdit::Redraw | CMFCRibbonEdit コントロールの表示を更新します。 |
| CMFCRibbonEdit::SetACCData | CMFCRibbonEdit オブジェクトのアクセシビリティ データを設定します。 |
| CMFCRibbonEdit::SetEditText | テキスト ボックス内のテキストを設定します。 |
| CMFCRibbonEdit::SetTextAlign | テキスト ボックスのテキストの配置を設定します。 |
| CMFCRibbonEdit::SetWidth | CMFCRibbonEdit コントロールのテキスト ボックスの幅を設定します。 |
解説
例
次の例では、 CMFCRibbonEdit オブジェクトを作成し、編集コントロールの横にスピン ボタンを表示し、編集コントロールのテキストを設定する方法を示します。 このコード スニペットは、 MS Office 2007 Demo サンプルの一部です。
CMFCRibbonEdit *pEditIndentLeft = new CMFCRibbonEdit(ID_PAGELAYOUT_INDENT_LEFT, 72, _T("Left:\nil"), 13);
// specify the min and max value of the spin button control
pEditIndentLeft->EnableSpinButtons(0, 1000);
// set the text of the edit control
pEditIndentLeft->SetEditText(_T("0"));
要件
Header: afxRibbonEdit.h
CMFCRibbonEdit::CanBeStretched
CMFCRibbonEdit コントロールの高さをリボン行の高さに合わせることができるかどうかを示します。
virtual BOOL CanBeStretched();
戻り値
常に FALSE を返します。
解説
CMFCRibbonEdit::CMFCRibbonEdit
CMFCRibbonEdit オブジェクトを構築します。
CMFCRibbonEdit(
UINT nID,
int nWidth,
LPCTSTR lpszLabel = NULL,
int nImage = -1);
CMFCRibbonEdit();
パラメーター
nID
[in] CMFCRibbonEdit コントロールのコマンド ID。
nWidth
[in] CMFCRibbonEdit コントロールのテキスト ボックスの幅 (ピクセル単位)。
lpszLabel
[in] CMFCRibbonEdit コントロールのラベル。
nImage
[in] CMFCRibbonEdit コントロールに使用する小さなイメージのインデックス。 小さいイメージのコレクションは、親リボン カテゴリによって管理されます。
解説
CMFCRibbonEdit コントロールでは、大きなイメージは使用されません。
CMFCRibbonEdit::CopyFrom
指定した CMFCRibbonEdit オブジェクトの状態を現在の CMFCRibbonEdit オブジェクトにコピーします。
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
パラメーター
src
[in]ソース CMFCRibbonEdit オブジェクト。
解説
src パラメーターはCMFCRibbonEdit型である必要があります。
CMFCRibbonEdit::CreateEdit
CMFCRibbonEdit オブジェクトの新しいテキスト ボックスを作成します。
virtual CMFCRibbonRichEditCtrl* CreateEdit(
CWnd* pWndParent,
DWORD dwEditStyle);
パラメーター
pWndParent
[in] CMFCRibbonEdit オブジェクトの親ウィンドウへのポインター。
dwEditStyle
[in]テキスト ボックスのスタイルを指定します。 「解説」セクションにリストされているウィンドウ・スタイルと、Windows SDK で説明されている 編集コントロール・スタイル を組み合わせることができます。
戻り値
メソッドが成功した場合の新しいテキスト ボックスへのポインター。それ以外の場合は NULL。
解説
カスタム テキスト ボックスを作成するには、派生クラスでこのメソッドをオーバーライドします。
次の ウィンドウ スタイル をテキスト ボックスに適用できます。
WS_CHILD
WS_VISIBLE
WS_DISABLED
WS_GROUP
WS_TABSTOP
CMFCRibbonEdit::D estroyCtrl
CMFCRibbonEdit オブジェクトを破棄します。
virtual void DestroyCtrl();
解説
CMFCRibbonEdit::D ropDownList
リスト ボックスをドロップダウンします。
virtual void DropDownList();
解説
既定では、このメソッドは何も行いません。 リスト ボックスをドロップダウンするには、このメソッドをオーバーライドします。
CMFCRibbonEdit::EnableSpinButtons
テキスト ボックスのスピン ボタンの範囲を有効にして設定します。
void EnableSpinButtons(
int nMin,
int nMax);
パラメーター
nMin
[in]スピン ボタンの最小値。
nMax
[in]スピン ボタンの最大値。
解説
スピン ボタンには上下の矢印が表示され、ユーザーは固定された値のセット内を移動できます。
CMFCRibbonEdit::GetCompactSize
CMFCRibbonEdit オブジェクトのコンパクト サイズを取得します。
virtual CSize GetCompactSize(CDC* pDC);
パラメーター
pDC
[in] CMFCRibbonEdit オブジェクトのデバイス コンテキストへのポインター。
戻り値
CMFCRibbonEdit オブジェクトのコンパクト サイズ。
解説
CMFCRibbonEdit::GetEditText
テキスト ボックス内のテキストを取得します。
CString GetEditText() const;
戻り値
テキスト ボックス内のテキスト。
解説
CMFCRibbonEdit::GetIntermediateSize
CMFCRibbonEdit オブジェクトの中間サイズを取得します。
virtual CSize GetIntermediateSize(CDC* pDC);
パラメーター
pDC
[in] CMFCRibbonEdit オブジェクトのデバイス コンテキストへのポインター。
戻り値
CMFCRibbonEdit オブジェクトの中間サイズ。
解説
CMFCRibbonEdit::GetTextAlign
テキスト ボックス内のテキストの配置を取得します。
int GetTextAlign() const;
戻り値
テキスト配置の列挙値。 可能な値については、「備考」セクションを参照してください。
解説
返される値は、次のいずれかの編集コントロール スタイルです。
左揃えのES_LEFT
中央揃えのES_CENTER
適切な配置のES_RIGHT
これらのスタイルの詳細については、「コントロール スタイルの編集を参照してください。
CMFCRibbonEdit::GetWidth
CMFCRibbonEdit コントロールの幅をピクセル単位で取得します。
int GetWidth(BOOL bInFloatyMode = FALSE) const;
パラメーター
bInFloatyMode
[in] CMFCRibbonEdit コントロールがフローティング モードの場合は TRUE。それ以外の場合は FALSE。
戻り値
CMFCRibbonEdit コントロールの幅 (ピクセル単位)。
解説
CMFCRibbonEdit::HasCompactMode
CMFCRibbonEdit コントロールの表示サイズをコンパクトにできるかどうかを示します。
virtual BOOL HasCompactMode() const;
戻り値
常に TRUE が返されます。
解説
既定では、このメソッドは常に TRUE を返します。 表示サイズをコンパクトにできるかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonEdit::HasFocus
CMFCRibbonEdit コントロールにフォーカスがあるかどうかを示します。
virtual BOOL HasFocus() const;
戻り値
CMFCRibbonEdit コントロールにフォーカスがある場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonEdit::HasLargeMode
CMFCRibbonEdit コントロールの表示サイズを大きくできるかどうかを示します。
virtual BOOL HasLargeMode() const;
戻り値
常に FALSE を返します。
解説
既定では、このメソッドは常に FALSE を返します。 このメソッドをオーバーライドして、表示サイズを大きくできるかどうかを示します。
CMFCRibbonEdit::HasSpinButtons
テキスト ボックスにスピン ボタンがあるかどうかを示します。
virtual BOOL HasSpinButtons() const;
戻り値
テキスト ボックスにスピン ボタンがある場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonEdit::IsHighlighted
CMFCRibbonEdit コントロールが強調表示されているかどうかを示します。
virtual BOOL IsHighlighted() const;
戻り値
CMFCRibbonEdit コントロールが強調表示されている場合は TRUE、それ以外の場合は FALSE。
解説
CMFCRibbonEdit::OnAfterChangeRect
CMFCRibbonEdit コントロールの表示四角形の寸法が変更されたときにフレームワークによって呼び出されます。
virtual void OnAfterChangeRect(CDC* pDC);
パラメーター
pDC
[in] CMFCRibbonEdit コントロールのデバイス コンテキストへのポインター。
解説
CMFCRibbonEdit::OnDraw
CMFCRibbonEdit コントロールを描画するためにフレームワークによって呼び出されます。
virtual void OnDraw(CDC* pDC);
パラメーター
pDC
[in] CMFCRibbonEdit コントロールのデバイス コンテキストへのポインター。
解説
CMFCRibbonEdit::OnDrawLabelAndImage
CMFCRibbonEdit コントロールのラベルとイメージを描画するためにフレームワークによって呼び出されます。
virtual void OnDrawLabelAndImage(CDC* pDC);
パラメーター
pDC
[in] CMFCRibbonEdit コントロールのデバイス コンテキストへのポインター。
解説
CMFCRibbonEdit::OnDrawOnList
コマンド リスト ボックスに CMFCRibbonEdit コントロールを描画するためにフレームワークによって呼び出されます。
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
パラメーター
pDC
[in] CMFCRibbonEdit コントロールのデバイス コンテキストへのポインター。
strText
[in]表示テキスト。
nTextOffset
[in]リスト ボックスの左側から表示テキストまでの距離 (ピクセル単位)。
rect
[in] CMFCRibbonEdit コントロールの表示四角形。
bIsSelected
[入力] このパラメーターは使用しません。
bHighlighted
[入力] このパラメーターは使用しません。
解説
コマンド リスト ボックスには、ユーザーがクイック アクセス ツール バーをカスタマイズできるようにするためのリボン コントロールが表示されます。
CMFCRibbonEdit::OnEnable
CMFCRibbonEdit コントロールを有効または無効にするためにフレームワークによって呼び出されます。
virtual void OnEnable(BOOL bEnable);
パラメーター
bEnable
[in]コントロールを有効にする場合は TRUE。コントロールを無効にする場合は FALSE。
解説
CMFCRibbonEdit::OnHighlight
ポインターが CMFCRibbonEdit コントロールの境界を出入りするときにフレームワークによって呼び出されます。
virtual void OnHighlight(BOOL bHighlight);
パラメーター
bHighlight
[in]ポインターが CMFCRibbonEdit コントロールの境界内にある場合は TRUE、それ以外の場合は FALSE。
解説
CMFCRibbonEdit::OnKey
ユーザーがキーヒントを押し、 CMFCRibbonEdit コントロールにフォーカスがあるときに、フレームワークによって呼び出されます。
virtual BOOL OnKey(BOOL bIsMenuKey);
パラメーター
bIsMenuKey
[in]キーヒントにポップアップ メニューが表示される場合は TRUE。それ以外の場合は FALSE。
戻り値
イベントが処理された場合は TRUE。それ以外の場合は FALSE。
解説
CMFCRibbonEdit::OnLButtonDown
ユーザーがコントロールのマウスの左ボタンを押したときに、 CMFCRibbonEdit コントロールを更新するためにフレームワークによって呼び出されます。
virtual void OnLButtonDown(CPoint point);
パラメーター
point
[入力] このパラメーターは使用しません。
解説
CMFCRibbonEdit::OnLButtonUp
ユーザーがマウスの左ボタンを離したときにフレームワークによって呼び出されます。
virtual void OnLButtonUp(CPoint point);
パラメーター
point
[入力] このパラメーターは使用しません。
解説
CMFCRibbonEdit::OnRTLChanged
レイアウトの方向が変わると、 CMFCRibbonEdit コントロールを更新するためにフレームワークによって呼び出されます。
virtual void OnRTLChanged(BOOL bIsRTL);
パラメーター
bIsRTL
[in]レイアウトが右から左の場合は TRUE。レイアウトが左から右の場合は FALSE。
解説
CMFCRibbonEdit::OnShow
CMFCRibbonEdit コントロールを表示または非表示にするためにフレームワークによって呼び出されます。
virtual void OnShow(BOOL bShow);
パラメーター
bShow
[in]コントロールを表示する場合は TRUE。コントロールを非表示にする場合は FALSE。
解説
CMFCRibbonEdit::Redraw
CMFCRibbonEdit コントロールの表示を更新します。
virtual void Redraw();
解説
このメソッドは、RDW_INVALIDATE、RDW_ERASE、およびRDW_UPDATENOWフラグが設定された CWnd::RedrawWindow を間接的に呼び出すことによって、CMFCRibbonEdit オブジェクトの表示四角形を再描画します。
CMFCRibbonEdit::SetACCData
CMFCRibbonEdit オブジェクトのアクセシビリティ データを設定します。
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
パラメーター
pParent
CMFCRibbonEdit オブジェクトの親ウィンドウへのポインター。
data
CMFCRibbonEdit オブジェクトのアクセシビリティ データ。
戻り値
常に TRUE が返されます。
解説
CMFCRibbonEdit::SetEditText
テキスト ボックス内のテキストを設定します。
void SetEditText(CString strText);
パラメーター
strText
[in]テキスト ボックスのテキスト。
CMFCRibbonEdit::SetTextAlign
テキスト ボックスのテキストの配置を設定します。
void SetTextAlign(int nAlign);
パラメーター
nAlign
[in]テキスト配置の列挙値。 可能な値については、「備考」セクションを参照してください。
解説
パラメーター nAlign は、次のいずれかの編集コントロール スタイルです。
左揃えのES_LEFT
中央揃えのES_CENTER
右揃えのES_RIGHT
これらのスタイルの詳細については、「コントロール スタイルの編集を参照してください。
CMFCRibbonEdit::SetWidth
CMFCRibbonEdit コントロールのテキスト ボックスの幅を設定します。
void SetWidth(
int nWidth,
BOOL bInFloatyMode = FALSE);
パラメーター
nWidth
[in]テキスト ボックスの幅 (ピクセル単位)。
bInFloatyMode
フローティング モードの幅を設定する場合は TRUE。標準モードの幅を設定する場合は FALSE。
解説
CMFCRibbonEdit コントロールには、表示モードに応じて、フローティング モードと標準モードの 2 つの幅があります。